Skip to content

Commit 77f6c80

Browse files
Add Merge Checklist
1 parent 2018b6c commit 77f6c80

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

docs/other/merge-checklist.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Before merging a pull request, we should consider the following:
2+
3+
Making sure to update related things:
4+
5+
- has CHANGELOG.md been updated?
6+
- has MAINTAINERS.md been updated?
7+
- has the app's version number been incremented?
8+
- has the [https://GitHub.com/MicroPythonOS/docs](documentation) been updated?
9+
10+
Making sure the logic is sound:
11+
12+
- if it changes a setting definition, will old settings be properly migrated to the new setting?
13+
- has a unit test been added or updated to make catch future regressions?
14+
15+
Making sure it's easy to review:
16+
17+
- are whitespace changes done in a separate commit (or ideally, separate pull request) from functional changes?
18+

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,7 @@ nav:
8787
- Porting Guide: os-development/porting-guide.md
8888
- Other:
8989
- Release Process: other/release-checklist.md
90+
- Merge Checklist: other/merge-checklist.md
9091
extra:
9192
social:
9293
- icon: fontawesome/brands/github

0 commit comments

Comments
 (0)