-
Notifications
You must be signed in to change notification settings - Fork 113
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a PR and git commit template (#82)
Prior to this change, we had no standards for our commit messages. Now we shall! You can use the template by configuring your local git: ``` git config commit.template .git_commit_msg.txt ```
- Loading branch information
Showing
3 changed files
with
99 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# If applied, this commit will... | ||
|
||
|
||
# this bar is where 50 columns is at --------->| | ||
# Complete the sentence above, | ||
# + Capitalize it! | ||
# + Don't end with a period (full-stop)! | ||
# | ||
# Commit description, use maximum 72 chars | ||
# | ||
# Why is this change needed? | ||
Prior to this change, | ||
|
||
|
||
# this bar is where 72 columns is at ---------------------------->| | ||
# | ||
# How does it address the issue? | ||
This change | ||
|
||
|
||
# this bar is where 72 columns is at ---------------------------->| | ||
# | ||
# Provide links to any relevant tickets, articles or other resources | ||
|
||
|
||
# this bar is where 72 columns is at ---------------------------->| | ||
# | ||
# For more details on how to write a good commit message please visit: | ||
# https://chris.beams.io/posts/git-commit/ | ||
# | ||
# Thank you for taking the time to write a good commit message! | ||
# We highly appreciate it! | ||
# Take a hug! (づ。◕‿‿◕。)づ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
<!--- Provide a general summary of your changes in the Title above --> | ||
<!--- in NOT MORE THAN 50 characters. Keep it short, pls. --> | ||
|
||
## Motivation and Context | ||
<!--- Why is this change required? What problem does it solve? --> | ||
<!--- If it fixes an open issue, please link to the issue here. --> | ||
<!--- If it delivers a story on the Pivotal tracker, please link to it here. --> | ||
|
||
## Describe your changes | ||
<!--- List and detail all changes made in this PR. --> | ||
|
||
## Any further comments? | ||
|
||
<!-- If this is a relatively large or complex change, kick off the discussion by --> | ||
<!-- explaining why you chose the solution you did and what alternatives you --> | ||
<!-- considered, etc... --> | ||
|
||
------ | ||
|
||
## Checklist | ||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. --> | ||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> | ||
- [ ] I have read [CONTRIBUTING.md][contributing]. | ||
- [ ] My code follows the [style guidelines][contributing] of this project. | ||
- [ ] I have commented my code, particularly in hard-to-understand areas. | ||
- [ ] My code does not generate any (new) [`credo`][credo] and compile-time warnings. | ||
- [ ] I have updated the documentation wherever necessary. | ||
- [ ] I have added tests to cover my changes. | ||
|
||
[contributing]: https://github.com/aviabird/snitch/CONTRIBUTING.md | ||
[credo]: https://github.com/rrrene/credo | ||
|
||
<!--- DO NOT REMOVE SECTION BELOW --> | ||
------ | ||
Dear Gatekeeper, | ||
|
||
Please make sure that the commits that will be merged or rebased into the base | ||
branch are [formatted according to our standards](commit-template). | ||
|
||
> The only additional requirement is that the the PR number must appear in the | ||
> commit title in brackets: `(#XXX)` | ||
[commit-template]: https://github.com/aviabird/snitch/blob/develop/.git_commit_msg.txt |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters