Skip to content

Commit

Permalink
fix: sugested changes from pr
Browse files Browse the repository at this point in the history
  • Loading branch information
cernicc committed May 27, 2024
1 parent 21471a6 commit fbc3fe4
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
### Description

Write an explicit description about what the commit changes, and how you
implemented the change. The quality of the descriptions directly impacts the
quality of the review and because of this - PR’s without proper description will
be declined.
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

Expand All @@ -12,8 +16,11 @@ review. Like link to specs if implementing a protocol.

### Checklist

[ ] Make sure that you described overall what does this change do.
[ ] What are the important points that reviewers should now?
[ ] If there are follow-ups, have you created issues for them?
[ ] Have you tested this solution?
[ ] Were there any alternative implementations considered?
- [ ] 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 fbc3fe4

Please sign in to comment.