Skip to content

Commit 25c3717

Browse files
committed
Introduce commit message style guidelines
1 parent 8ccc710 commit 25c3717

File tree

1 file changed

+47
-0
lines changed

1 file changed

+47
-0
lines changed

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,53 @@ At the same time, this freedom comes with certain responsibilities, which are ro
126126
Balancing the handling of pull requests is important to *keep the development process scalable*.
127127

128128

129+
### Commit Message
130+
131+
Commits should adhere to the following conventions:
132+
133+
```
134+
<type>[optional scope]: <description>
135+
136+
[optional body]
137+
138+
[optional footer(s)]
139+
```
140+
141+
Where:
142+
143+
```
144+
type = feat | fix | docs | test | chore ;
145+
146+
feat -> external behavior changes
147+
fix -> incorrect behavior corrected
148+
refactor -> internal change, behavior preserved
149+
docs -> documentation only
150+
test -> tests only
151+
chore -> maintenance only (CI, dependency bump)
152+
```
153+
154+
Some examples:
155+
```
156+
feat(compiler): add basic constant folding pass
157+
fix: handle zero-size tensors in lowering
158+
refactor: split up LLVM lowering pass
159+
docs: improve GPU lowering guidelines
160+
```
161+
162+
or
163+
164+
```
165+
feat(runtime): add kernel for softmax on gpu
166+
167+
Add a kernel of the softmax operation on NVIDIA and AMD GPUs.
168+
169+
Refs: 676104e
170+
Closes #123, #456
171+
```
172+
173+
Limit the commit message title to `<=50` and the commit message body to `<=72` characters per line.
174+
175+
129176
### Code Style
130177

131178
Before contributing, please make sure to run `clang-format` on your C++ (.h and

0 commit comments

Comments
 (0)