Skip to content

Commit dfadf67

Browse files
docs: commit message style guidelines (#995)
1 parent 5430f70 commit dfadf67

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,58 @@ 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 | refactor | docs | test | chore | perf | style | revert;
145+
146+
feat -> adds a new feature (internal or external)
147+
fix -> fixes an incorrect behavior
148+
refactor -> internal change, no new features
149+
docs -> documentation only
150+
test -> tests only
151+
chore -> maintenance only (CI, dependency bump)
152+
perf -> performance related changes
153+
style -> code-style changes
154+
revert -> to revert previous commits
155+
```
156+
Use a single commit type per commit, choose by best judgement.
157+
A scope may be provided to a commit’s type, to provide additional contextual
158+
information and is contained within parenthesis, e.g., `feat(parser): add ability to parse arrays`.
159+
160+
Some examples:
161+
```
162+
feat(compiler): add basic constant folding pass
163+
fix: handle zero-size tensors in lowering
164+
refactor: split up LLVM lowering pass
165+
docs: improve GPU lowering guidelines
166+
```
167+
168+
```
169+
feat(runtime): add kernel for softmax on gpu
170+
171+
Add a kernel of the softmax operation on NVIDIA and AMD GPUs.
172+
173+
Refs: 676104e
174+
Closes #123, #456
175+
```
176+
177+
We recommend to limit the commit message title to `<=50` and the commit message
178+
body to `<=72` characters per line.
179+
180+
129181
### Code Style
130182

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

0 commit comments

Comments
 (0)