... | ... | @@ -35,20 +35,6 @@ $ git config --global user.email "your_email@youremail.com" |
|
|
|
|
|
This will set your name and email globally. To set it for just the GHC repo, remove the `--global` flag. Also, the environment variables `GIT_COMMITTER_NAME`, `GIT_COMMITTER_EMAIL`, `GIT_AUTHOR_NAME` and `GIT_AUTHOR_EMAIL` will override git-config settings if they are defined.
|
|
|
|
|
|
## Commit messages
|
|
|
|
|
|
|
|
|
Please try to follow the general convention for the [ Git commit message structure](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) as many Git tools rely on this. Moreover, take into account that the commit message text is interpreted as [WikiFormatting](wiki-formatting) in Trac.
|
|
|
|
|
|
|
|
|
In particular, if your patch addresses or fixes a bug/ticket, then include the ticket number in the form "`#NNNN`" in the commit message, e.g.
|
|
|
|
|
|
```wiki
|
|
|
withMVar family have a bug (fixes #767)
|
|
|
```
|
|
|
|
|
|
***Git will then add a link to the commit from the ticket*** (as soon as the commit becomes reachable from the `master` HEAD), so that people watching the ticket can see that a fix has been committed, and in the future we can easily find the patch that addressed the ticket. When navigating the Git history on Trac, you will also be able to jump directly to the ticket from the commit.
|
|
|
|
|
|
## Line endings
|
|
|
|
|
|
|
... | ... | @@ -98,6 +84,20 @@ to stop git in the ghc repo from checking for unrecorded changes in the submodul |
|
|
|
|
|
See [WorkingConventions/Git/Tricks](working-conventions/git/tricks).
|
|
|
|
|
|
## Commit messages
|
|
|
|
|
|
|
|
|
Please try to follow the general convention for the [ Git commit message structure](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) as many Git tools rely on this. Moreover, take into account that the commit message text is interpreted as [WikiFormatting](wiki-formatting) in Trac.
|
|
|
|
|
|
|
|
|
In particular, if your patch addresses or fixes a bug/ticket, then include the ticket number in the form "`#NNNN`" in the commit message, e.g.
|
|
|
|
|
|
```wiki
|
|
|
withMVar family have a bug (fixes #767)
|
|
|
```
|
|
|
|
|
|
***Git will then add a link to the commit from the ticket*** (as soon as the commit becomes reachable from the `master` HEAD), so that people watching the ticket can see that a fix has been committed, and in the future we can easily find the patch that addressed the ticket. When navigating the Git history on Trac, you will also be able to jump directly to the ticket from the commit.
|
|
|
|
|
|
## Contributing patches
|
|
|
|
|
|
|
... | ... | |