Skip to content

Commit 386f818

Browse files
committed
Add pull request template
Fix typo in CONTRIBUTING.md
1 parent 05a6759 commit 386f818

File tree

2 files changed

+66
-1
lines changed

2 files changed

+66
-1
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
<!-- Please fill out the pull request template included below, failure -->
2+
<!-- to do so may result in immediate closure of your pull request. -->
3+
4+
<!-- Fill out all portions of this template that apply. Please delete -->
5+
<!-- any unnecessary sections. -->
6+
7+
This pull request (PR) is a:
8+
- [ ] Bug fix
9+
- [ ] Feature addition
10+
- [ ] Other, Please describe:
11+
12+
I certify that:
13+
14+
- [ ] I have reviewed the [contributing guidelines]
15+
- [ ] If this PR is a work in progress I have added `WIP:` to the
16+
beginning of the PR title
17+
- [ ] If this PR is problematic for any reason, I have added
18+
`DO NOT MERGE:` to the beginning of the title
19+
- [ ] The branch name and title of this PR contains the text
20+
`issue-<#>` where `<#>` is replaced by the issue that this PR
21+
is addressing
22+
- [ ] I have deleted trailing white space on any lines that this PR
23+
touches
24+
- [ ] I have used spaces for indentation on any lines that this PR
25+
touches
26+
- [ ] I have included some comments to explain non-obvious code
27+
changes
28+
- [ ] I have run the tests localy (`ctest`) and all tests pass
29+
- [ ] Each commit is a logically atomic, self-consistent, cohesive
30+
set of changes
31+
- [ ] The [commit message] should follow [these guidelines]:
32+
- [ ] First line is directive phrase, starting with a capitalized
33+
imperative verb, and is no longer than 50 characters
34+
summarizing your commit
35+
- [ ] Next line, if necessary is blank
36+
- [ ] Following lines are all wrapped at 72 characters and can
37+
include additional paragraphs, bulleted lists, etc.
38+
- [ ] Use [Github keywords] where appropriate, to indicate the
39+
commit resolves an open issue.
40+
- [ ] I have signed [Contributor License Agreement (CLA)] by
41+
clicking the "details" link to the right of the `licence/cla`
42+
check and following the directions on the CLA assistant webpage
43+
44+
## Summary of changes ##
45+
46+
Summarize what you changed
47+
48+
## Rationale for changes ##
49+
50+
Why did you make these changes?
51+
52+
## For contributors and SI team members with code review priviledges ##
53+
54+
- [ ] I certify that I will wait 24 hours before self-approving via
55+
[pullapprove comment] or [Github code review] so that someone
56+
else has the chance to review my proposed changes
57+
58+
[links]:#
59+
[contributing guidelines]: https://github.com/sourceryinstitute/opencoarrays/blob/master/CONTRIBUTING.md
60+
[commit message]: https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message
61+
[these guidelines]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
62+
[Contributor License Agreement (CLA)]: https://cla-assistant.io/sourceryinstitute/opencoarrays
63+
[pullapprove comment]: https://pullapprove.com/sourceryinstitute/opencoarrays/settings/
64+
[Github code review]: https://help.github.com/articles/about-pull-request-reviews/
65+
[Github keywords]: https://help.github.com/articles/closing-issues-via-commit-messages/

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Here is a checklist to help you get started contributing to OpenCoarrays and wal
7171
- [ ] Next line, if necessary is blank
7272
- [ ] Following lines are all wrapped at 72 characters and can include additional paragraphs, bulleted lists, etc.
7373
- [ ] Use [Github keywords] where appropriate, to indicate the commit resolves an open issue.
74-
- [ ] Please do you best to keep a [clean and coherent history]. `git add -p ...`, `git commit --amend` and `git rebase --interactive <root-ref>` can be helpful to rework your commits into a cleaner, clearer state.
74+
- [ ] Please do your best to keep a [clean and coherent history]. `git add -p ...`, `git commit --amend` and `git rebase --interactive <root-ref>` can be helpful to rework your commits into a cleaner, clearer state.
7575
- [ ] Next, [open up a pull request] where the base branch is [`master`] or [`devel`] as appropriate
7676
- [ ] Please be patient and responsive to requests and comments from SourceryInstitute (SI) team members. You may be asked to amend or otherwise alter commits, or push new commits to your branch.
7777
- [ ] Make sure that all the automated [Travis-CI tests] pass

0 commit comments

Comments
 (0)