diff options
| author | Martin Erlandsson <martin@megabit.se> | 2018-10-29 13:04:55 +0100 |
|---|---|---|
| committer | Martin Erlandsson <martin@megabit.se> | 2018-10-30 07:59:10 +0100 |
| commit | 0e6de3aacb8ebbf2617e8c11b8dae61acdd79816 (patch) | |
| tree | 5cacf64848a6e0c1ad730c2fb2432465474184b7 | |
| parent | f1e2f2a85962c1664e4e55471061af0eaa798d40 (diff) | |
added details about commit messages
| -rw-r--r-- | CONTRIBUTING.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d5dc3221b..08b2fa609e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,6 +67,8 @@ If a particular commit references another issue, please add the reference. For example: `refs #1234` or `fixes #4321`. Using the `fixes` or `closes` keywords will cause the corresponding issue to be closed when the pull request is merged. +Commit messages should never contain any `@` mentions. + Please refer to the [Git manual](https://git-scm.com/doc) for more information about Git. @@ -135,6 +137,10 @@ before it will be merged. The basic squashing workflow is shown below. # Save and quit. git push -f # (force push to GitHub) +Please update the resulting commit message if needed, it should read as a +coherent message. In most cases this means that you should not just list the +interim commits. + If you have problems with squashing (or other workflows with `git`), you can alternatively enable "Allow edits from maintainers" in the right GitHub sidebar and ask for help in the pull request. |