Skip to content

Commit d79d09b

Browse files
committed
Add reminder about updating CHANGELOG to CONTRIBUTING
Also added a link to what makes a well formed commit message
1 parent 4493fbc commit d79d09b

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,14 @@ Looking to contribute something to [json-fortran](README.md)? **Here's how you c
5252
- Try not to pollute your pull request with unintended changes--keep them simple and small
5353
- Pull requests should address one issue at a time, and each commit should be a set of self contained, related changes. If you forget something in a commit, please use `git rebase -i <ref>^` to amend and/or squash erroneous commits. Here `<ref>` is the reference to to oldest commit needing to be modified (SHA, or `HEAD~4`, etc.)
5454
- Each commit should compile, and ideally pass the tests. Very complicated new features or fixes, may have commits that don't pass tests, if otherwise the commit history would include far to many changes in any given commit. Use an interactive rebase to fix any of these issues, as described above.
55+
- Each commit should have a concise, descriptive message following the
56+
guidlines laid out
57+
[here](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
58+
- Make sure to document your changes in the
59+
[CHANGELOG](https://github.com/jacobwilliams/json-fortran/blob/master/CHANGELOG.md)
60+
under the
61+
['unreleased'](https://github.com/jacobwilliams/json-fortran/blob/master/CHANGELOG.md#unreleased)
62+
heading.
5563
- Pull requests should always be based on the upstream master,
5664
`jacobwilliams/json-fortran:master`. Please `rebase` your branch on top
5765
of the latest upstream master. Assuming you are on your branch and you've added the upstream remote by running something like:

0 commit comments

Comments
 (0)