Skip to content

Commit ee8d657

Browse files
committed
Update Pull Request template
- Make it easier to fill out, with fewer checkboxes
1 parent fdc783d commit ee8d657

File tree

2 files changed

+208
-136
lines changed

2 files changed

+208
-136
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,19 @@
44
<!-- Fill out all portions of this template that apply. Please delete -->
55
<!-- any unnecessary sections. -->
66

7-
| Avg response time | coverage on master |
8-
| --------------------------------- | ---------------------------|
9-
| ![Issue Stats][PR response img] | ![Codecov branch][coverage]|
7+
<!-- PRO TIP! Submit the pull request *before* you check any -->
8+
<!-- checkboxes. Then, use the gui/web interface to check the -->
9+
<!-- checkboxes! -->
10+
11+
[links]:#
12+
[contributing guidelines]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/CONTRIBUTING.md
13+
[issue]: https://github.com/sourceryinstitute/OpenCoarrays/issues
14+
[PR response img]: https://img.shields.io/issuestats/p/github/sourceryinstitute/OpenCoarrays.svg?style=flat-square
15+
[coverage]: https://img.shields.io/codecov/c/github/sourceryinstitute/OpenCoarrays/master.svg?style=flat-square
16+
17+
| Avg response time | coverage on master |
18+
|:---------------------------------:|:---------------------------:|
19+
| ![Issue Stats][PR response img] | ![Codecov branch][coverage] |
1020

1121
## Summary of changes ##
1222

@@ -19,58 +29,25 @@ Why did you make these changes?
1929
## Additional info and certifications ##
2030

2131
This pull request (PR) is a:
22-
- [ ] Bug fix
23-
- [ ] Feature addition
24-
- [ ] Other, Please describe:
25-
26-
I certify that:
27-
28-
- [ ] I have reviewed the [contributing guidelines]
29-
- [ ] If this PR is a work in progress I have added `WIP:` to the
30-
beginning of the PR title
31-
- [ ] If this PR is problematic for any reason, I have added
32-
`DO NOT MERGE:` to the beginning of the title
33-
- [ ] The branch name and title of this PR contains the text
34-
`issue-<#>` where `<#>` is replaced by the issue that this PR
35-
is addressing
36-
- [ ] I have deleted trailing white space on any lines that this PR
37-
touches
38-
- [ ] I have used spaces for indentation on any lines that this PR
39-
touches
40-
- [ ] I have included some comments to explain non-obvious code
41-
changes
42-
- [ ] I have run the tests localy (`ctest`) and all tests pass
43-
- [ ] Each commit is a logically atomic, self-consistent, cohesive
44-
set of changes
45-
- [ ] The [commit message] should follow [these guidelines]:
46-
- [ ] First line is directive phrase, starting with a capitalized
47-
imperative verb, and is no longer than 50 characters
48-
summarizing your commit
49-
- [ ] Next line, if necessary is blank
50-
- [ ] Following lines are all wrapped at 72 characters and can
51-
include additional paragraphs, bulleted lists, etc.
52-
- [ ] Use [Github keywords] where appropriate, to indicate the
53-
commit resolves an open issue.
54-
- [ ] I have signed [Contributor License Agreement (CLA)] by
55-
clicking the "details" link to the right of the `licence/cla`
56-
check and following the directions on the CLA assistant webpage
57-
- [ ] I have ensured that the test coverage hasn't gone down and added new [unit tests] to cover an new code added to the library
5832

59-
60-
## For contributors and SI team members with code review priviledges ##
61-
62-
- [ ] I certify that I will wait 24 hours before self-approving via
63-
[pullapprove comment] or [Github code review] so that someone
64-
else has the chance to review my proposed changes
65-
66-
[links]:#
67-
[contributing guidelines]: https://github.com/sourceryinstitute/OpenCoarrays/blob/master/CONTRIBUTING.md
68-
[commit message]: https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message
69-
[these guidelines]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
70-
[Contributor License Agreement (CLA)]: https://cla-assistant.io/sourceryinstitute/OpenCoarrays
71-
[pullapprove comment]: https://pullapprove.com/sourceryinstitute/OpenCoarrays/settings/
72-
[Github code review]: https://help.github.com/articles/about-pull-request-reviews/
73-
[Github keywords]: https://help.github.com/articles/closing-issues-via-commit-messages/
74-
[unit tests]: https://github.com/sourceryinstitute/OpenCoarrays/tree/master/src/tests/unit
75-
[PR response img]: https://img.shields.io/issuestats/p/github/sourceryinstitute/OpenCoarrays.svg?style=flat-square
76-
[coverage]: https://img.shields.io/codecov/c/github/sourceryinstitute/OpenCoarrays/master.svg?style=flat-square
33+
- [ ] Bug fix
34+
- [ ] Feature addition
35+
- [ ] Other, Please describe:
36+
37+
### I certify that ###
38+
39+
- [ ] I have reviewed the [contributing guidelines] and followed the
40+
policies on:
41+
- Pull request (PR) naming to indicate work in progress (WIP),
42+
and to attach the PR to the appropriate bug report, or feature
43+
request [issue]
44+
- White space (no trailing white space or white space errors may
45+
be introduced)
46+
- Commenting code where it is non-obvious and non-trivial
47+
- Running tests locally, to ensure all of them pass
48+
- Maintaining or increasing test coverage
49+
- Logically atomic, self consistent and coherent commits
50+
- Commit message content
51+
- Waiting 24 hours before self-approving the pull request to
52+
give another OpenCoarrays developer a chance to review my
53+
proposed code

0 commit comments

Comments
 (0)