-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: changed the format and content
- Loading branch information
Showing
1 changed file
with
13 additions
and
4 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,10 +1,19 @@ | ||
# Description | ||
### 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. Add some additional resources that could help the reviewer with the | ||
be declined. | ||
|
||
### 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: | ||
[] - Checked that the CI is successful | ||
### 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? |