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.

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: add pr template #43

Merged
merged 3 commits into from
May 27, 2024
Merged
Changes from all commits
Commits
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
26 changes: 26 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
### Description

Write an explicit description about what the PR changes, and how you implemented
the change.

The quality of the description directly impacts the quality of the review
process for everyone. Adding relevant context (i.e. describing the reasons for
the change, adding links to relevant documents, etc) to your description ensures
that everyone is able to easily gather the context necessary to review your
change.

### Important points for reviewers

Add some additional resources that could help the reviewer with the
review. Like link to specs if implementing a protocol.
cernicc marked this conversation as resolved.
Show resolved Hide resolved

### Checklist

- [ ] Are there important points that reviewers should know?
- [ ] If yes, which ones?
- [ ] Make sure that you described what this change does.
- [ ] If there are follow-ups, have you created issues for them?
- [ ] If yes, which ones? / List them here
- [ ] Have you tested this solution?
- [ ] Were there any alternative implementations considered?
- [ ] Did you document new (or modified) APIs?
Loading