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

chore(github): Update GitHub Pull Request Template #1370

Merged
merged 3 commits into from
May 23, 2023
Merged

chore(github): Update GitHub Pull Request Template #1370

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3d98e0
chore(github): Update GitHub Pull Request Template
Savio-Sou May 18, 2023
4a9d5bd
Make Example section optional
Savio-Sou May 23, 2023
7dedfe7
Revise doc comment wording
Savio-Sou May 23, 2023
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
60 changes: 40 additions & 20 deletions .github/pull_request_template.md
View file
Open in desktop
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.