Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Simplify PR checklist #178

Merged
merged 1 commit into from
Apr 6, 2022
Merged

Simplify PR checklist #178

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 27 additions & 26 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
# Comments for current PR
* *add your comments here*
* ...

# PR Checklist

<br><br />
<br><br />
*!!! WARNING : DO NOT EDIT THE CHECKLIST BELOW !!!*
# Checklist : Merge to DEVELOP branch
## Code Quality
- [ ] Each function has a header (description, inputs, outputs)
- [ ] Code is commented (particularly in hard to understand areas)
- [ ] There are no new warnings that can be corrected
- [ ] Commits policy is respected (constitancy commits, clear commits comments)
<br><br />
## Tests Review
- [ ] Manual Tests for new features have been *reviewed*
- [ ] Automatic Tests for new features have been *reviewed*
<br><br />
## Tests are passed the best as I can
- [ ] Non regression existing tests are *passed OK*
- [ ] New tests for new features & bug fixes are *passed OK*
<br><br />
## Documentation
- [ ] Documentation is up to date
- [ ] Changelog for next release is up-to-date
- [ ] If needed, tests are briefly described in test repository
### _1- PR Comments_
*If needed, to be filled by developer*

<br><hr/>
*WARNING : Do not edit the checklist below.*
<hr/><br>

### _2- Developer section_

- [ ] [Documentation] is up to date with new feature
- [ ] [Tests] are *passed OK* (Non regression, new features & bug fixes)
- [ ] [Code Quality] Remind to check if :
* Each function has a header (description, inputs, outputs)
* Code is commented (particularly in hard to understand areas)
* There are no new warnings that can be corrected
* Commits policy is respected (constitancy commits, clear commits comments)
<hr/><br>

### _3- QA section_

- [ ] [Review] tests for new features have been *reviewed*
- [ ] [Changelog] is up-to-date with expected tags
🆕 Feature: [Feature] Description...
🆕 Added: [Feature] Description...
🆕 Changed: [Feature] Description...
🛠️ Fix: [Feature] Description...