@@ -31,8 +31,8 @@ To contribute a patch, the workflow is as follows:
31
31
- Push topic branch to your copy of the repository.
32
32
- Raise a Pull Request via GitHub.
33
33
34
- The project coding conventions in the [ developer notes] ( doc/developer-notes.md )
35
- must be adhered to.
34
+ The coding conventions in the [ developer notes] ( doc/developer-notes.md ) must be
35
+ adhered to.
36
36
37
37
In general [ commits should be atomic] ( https://en.wikipedia.org/wiki/Atomic_commit#Atomic_commit_convention )
38
38
and diffs should be easy to read. For this reason do not mix any formatting
@@ -45,24 +45,15 @@ in init.cpp") then a single title line is sufficient. Commit messages should be
45
45
helpful to people reading your code in the future, so explain the reasoning for
46
46
your decisions. Further explanation [ here] ( http://chris.beams.io/posts/git-commit/ ) .
47
47
48
- If a particular commit references another issue, please add the reference, for
49
- example ` refs #1234 ` , or ` fixes #4321 ` . Using the ` fixes ` or ` closes ` keywords
50
- will cause the corresponding issue to be closed when the pull request is merged.
51
-
52
48
Please refer to the [ Git manual] ( https://git-scm.com/doc ) for more information
53
49
about Git.
54
50
55
- - Push changes to your fork
56
- - Create pull request
57
-
58
51
The body of the pull request should contain enough description about what the
59
52
patch does together with any justification/reasoning. You should include
60
53
references to any discussions (for example other tickets or mailing list
61
- discussions).
62
-
63
- At this stage one should expect comments and review from other contributors. You
64
- can add more commits to your pull request by committing them locally and pushing
65
- to your fork until you have satisfied all feedback.
54
+ discussions). At this stage one should expect comments and review from other
55
+ contributors. You can add more commits to your pull request by committing them
56
+ locally and pushing to your fork until you have satisfied feedback.
66
57
67
58
68
59
## Squashing Commits
0 commit comments