-
Notifications
You must be signed in to change notification settings - Fork 226
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(github): Update GitHub Pull Request Template (#1370)
* chore(github): Update GitHub Pull Request Template * Make Example section optional * Revise doc comment wording --------- Co-authored-by: Globallager <72797635+Globallager@users.noreply.github.com>
- Loading branch information
Showing
1 changed file
with
40 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,36 +1,56 @@ | ||
# Related issue(s) | ||
# Description | ||
|
||
<!-- If it does not already exist, first create a GitHub issue that describes the problem this Pull Request (PR) solves before creating the PR and link it here. --> | ||
<!-- Thanks for taking the time to improve Noir! --> | ||
<!-- Please fill out all fields marked with an asterisk (*). --> | ||
|
||
Resolves # <!-- link to issue --> | ||
## Problem\* | ||
|
||
# Description | ||
<!-- Describe the problem this Pull Request (PR) resolves / link to the GitHub Issue that describes the problem. --> | ||
|
||
## Summary of changes | ||
Resolves <!-- Link to GitHub Issue --> | ||
|
||
<!-- Describe the changes in this PR. Point out breaking changes if any. --> | ||
## Summary\* | ||
|
||
## Dependency additions / changes | ||
<!-- Describe the changes in this PR, particularly breaking changes if any. --> | ||
|
||
<!-- If applicable. --> | ||
This PR sets out to | ||
|
||
## Test additions / changes | ||
### Example | ||
|
||
<!-- If applicable. --> | ||
<!-- Code / step-by-step example(s) to demonstrate the effect of this PR. --> | ||
|
||
# Checklist | ||
Before: | ||
|
||
- [ ] I have tested the changes locally. | ||
- [ ] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` with default settings. | ||
- [ ] I have [linked](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) this PR to the issue(s) that it resolves. | ||
- [ ] I have reviewed the changes on GitHub, line by line. | ||
- [ ] I have ensured all changes are covered in the description. | ||
``` | ||
``` | ||
|
||
After: | ||
|
||
``` | ||
``` | ||
|
||
## Documentation | ||
|
||
## Documentation needs | ||
- [ ] This PR requires documentation updates when merged. | ||
|
||
<!-- If checked, list / describe what needs to be documented. --> | ||
<!-- If checked, check one of the following: --> | ||
|
||
# Additional context | ||
- [ ] I will submit a noir-lang/docs PR. | ||
|
||
<!-- If applicable. --> | ||
<!-- Submit a PR on https://github.com/noir-lang/docs. Thank you! --> | ||
|
||
- [ ] I will request for and support Dev Rel's help in documenting this PR. | ||
|
||
<!-- List / highlight what should be documented. --> | ||
<!-- Dev Rel will reach out for clarifications when needed. Thank you! --> | ||
|
||
## Additional Context | ||
|
||
<!-- Supplement further information if applicable. --> | ||
|
||
# PR Checklist\* | ||
|
||
- [ ] I have tested the changes locally. | ||
- [ ] I have formatted the changes with [Prettier](https://prettier.io/) and/or `cargo fmt` on default settings. |