You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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)}.
17
16
18
17
## Pull Requests
19
18
@@ -117,8 +116,30 @@ open an issue in the repository.
117
116
118
117
We have very precise rules over how git commit messages should be formatted.
119
118
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
+
```
122
143
123
144
#### Commit Message Format
124
145
@@ -149,8 +170,7 @@ Must be one of the following:
149
170
150
171
<**scope**>:
151
172
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.
154
174
155
175
<**subject**>:
156
176
@@ -190,3 +210,4 @@ and efficient communication Framework for providing developers and users with
190
210
helpful Documentation about the Deep Learning Framework.
0 commit comments