Skip to content

Commit

Permalink
Merge pull request #43 from eigerco/chore/40/pr_template
Browse files Browse the repository at this point in the history
chore: add pr template
  • Loading branch information
cernicc authored May 27, 2024
2 parents 7d8595f + fbc3fe4 commit e2811c6
Showing 1 changed file with 26 additions and 0 deletions.
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.

### 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?

0 comments on commit e2811c6

Please sign in to comment.