diff options
| author |  Marien Fressinaud <dev@marienfressinaud.fr>
| 2020-01-03 18:56:38 +0100 |
|---|---|---|
| committer | Marien Fressinaud <dev@marienfressinaud.fr>
| 2020-01-06 17:25:47 +0100 |
| commit | d455783a63e77c3abce76b85f68c51338c1b81d1 (patch) | |
| tree | 4f90d3153bbcd411f4eed4a5c92e91ae0733e8ee /docs/pull_request_template.md | |
| parent | 13cf8265f04ba0f28f514bf59f5acfad98e79d4a (diff) | |
Add guidance for pull requests
The main reason for this checklist is to not forget about documentation,
and to encourage us to write more tests. I hope it'll help us to improve
both!
Diffstat (limited to 'docs/pull_request_template.md')
| -rw-r--r-- | docs/pull_request_template.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/pull_request_template.md b/docs/pull_request_template.md new file mode 100644 index 000000000..5d1f225b7 --- /dev/null +++ b/docs/pull_request_template.md @@ -0,0 +1,22 @@ +Closes # + +Changes proposed in this pull request: + +- +- +- + +How to test the feature manually: + +1. +2. +3. + +Pull request checklist: + +- [ ] clear commit messages +- [ ] code manually tested +- [ ] unit tests written (optional if too hard) +- [ ] documentation updated + +[Additional information can be found in the documentation](https://github.com/FreshRSS/FreshRSS/tree/master/docs/en/developers/04_Pull_requests.md). |