Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Specification related PRs template #734

Merged
merged 2 commits into from
Sep 26, 2024
Merged

Specification related PRs template #734

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
98bb69e
Added template for specification related PRs
danielSanchezQ Sep 9, 2024
f78d1ab
Added new template
danielSanchezQ Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
## 1. What does this PR implement?

> [!NOTE]
> Review
>
the [Specification to Implementation Process document](https://www.notion.so/Specification-to-Implementation-Process-0cd6547233fa43a1a03d6e360de9eb2b).

## 2. Does the code have enough context to be clearly understood?

> [!IMPORTANT]
> Add a link to the specification document, pointing at the specific section.
> Any implementation detail that could be considered idiosyncratic and not direct from the specification, should be
> explained.
> Always consider what someone new would need to know for the code to make sense, and add this context to it.

## 3. Who are the specification authors and who is accountable for this PR?

> [!IMPORTANT]
> Ping the original specification author(s) and add them as reviewers, alongside any other from the engineering team.
> You are accountable for the PR and its rapid resolution, so make sure anyone involved is aware and actively
> advancing
> the review.

## 4. Is the specification accurate and complete?

> [!IMPORTANT]
> * If not, engage in a conversation directly with the authors, prompting any updates in the document.
> * You are accountable of this process, and the specification author needs to give priority to unblocking you.

## 5. Does the implementation introduce changes in the specification?

> [!IMPORTANT]
> * Contact the specification author(s) and engage in the necessary conversation to agree on the proposed
modification/solutions.
> * Ensure the new changes are on par with the implementation at the end of the process.
> * The PR should not be merged until parity between implementation and specifications has been reached.

## Checklist

> [!WARNING]
> Do not merge the PR if any of the following is missing:

* [ ] 1. Description added.
* [ ] 2. Context and links to Specification document(s) added.
* [ ] 3. Main contact(s) (developers and specification authors) added
* [ ] 4. Implementation and Specification are 100% in sync including changes. This is critical.
* [ ] 5. Link PR to a specific milestone.
Loading