Skip to content

Commit d00d304

Browse files
committed
Auto merge of #55 - MichaelHirn:master, r=MichaelHirn
docs/contributing: add commit message examples REFERENCE: #48
2 parents 60164d1 + b265726 commit d00d304

File tree

1 file changed

+27
-6
lines changed

1 file changed

+27
-6
lines changed

CONTRIBUTING.md

+27-6
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ overview of how you can contribute to Leaf.
1212
* [Documentation Guidelines](#documentation-guidelines)
1313

1414

15-
If you have questions hop on the [Leaf Chat](https://gitter.im/autumnai/leaf)
16-
, or reach out to {@[MJ](https://twitter.com/mjhirn), @[Max](https://twitter.com/hobofan)}.
15+
If you have questions hop on the [Leaf Chat](https://gitter.im/autumnai/leaf), to the #rust-machine-learning IRC on irc.mozilla.org or reach out to {@[MJ](https://twitter.com/mjhirn), @[Max](https://twitter.com/hobofan)}.
1716

1817
## Pull Requests
1918

@@ -117,8 +116,30 @@ open an issue in the repository.
117116

118117
We have very precise rules over how git commit messages should be formatted.
119118
This leads to more readable messages that are easy to follow when looking
120-
through the project history. But also, we may use the git commit messages to
121-
auto-generate the Leaf change log.
119+
through the project history. The commit guidelines help us to auto-generate the CHANGELOG. More information about it, can be found in the [`Guide to CHANGELOG in Rust` post][2].
120+
121+
#### Commit Message Examples
122+
123+
Following some valid commit message examples. A syntax explanation can be found in the following section, Commit Message Format.
124+
125+
Example for a mature commit message.
126+
```
127+
docs/readme: add contact section to README.md
128+
129+
A lot of people have asked about contact details, so I decided it would be a good idea to include our contact details in the README.md
130+
131+
REFERENCE: #4, #63
132+
CLOSE: #52
133+
```
134+
135+
Another example on how you would make the commit on the command line.
136+
```
137+
git commit -m 'feat/solver: add Adagrad as SGD-based solver
138+
139+
Some more context and explanation about the commit, PR.
140+
141+
CLOSE: #42'
142+
```
122143

123144
#### Commit Message Format
124145

@@ -149,8 +170,7 @@ Must be one of the following:
149170

150171
<**scope**>:
151172

152-
The scope could be anything that specifies the place of the commit change.
153-
For example: `feature1`, `tests`, `lib`, etc...
173+
The scope could be anything that specifies the place of the commit change, e.g. `solver`, `[filename]`, `tests`, `lib`, ... we are not very restrictive on the scope. The scope should just be lowercase and if possible contain of a single word, this makes the CHANGELOG generation easier.
154174

155175
<**subject**>:
156176

@@ -190,3 +210,4 @@ and efficient communication Framework for providing developers and users with
190210
helpful Documentation about the Deep Learning Framework.
191211

192212
[1]: https://medium.com/@autumn_eng/increasing-open-source-engagement-with-structural-communication-guidelines-for-code-documentation-e72533de8e45
213+
[2]: https://medium.com/@autumn_eng/guide-to-changelog-md-in-rust-6eb349808fa4

0 commit comments

Comments
 (0)