Skip to content

Commit ac7fe0d

Browse files
committed
doc(contrib): add example commit messages
Add three example commit messages shwoing different types and scopes.
1 parent d5e3d49 commit ac7fe0d

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

CONTRIBUTING.adoc

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,34 @@ BREAKING CHANGE: <breaking change summary>
127127
Fixes #<issue number>
128128
```
129129

130+
==== Examples
131+
132+
The following are examples of good commit messages:
133+
134+
```
135+
data(ext): add Smclic extension
136+
137+
Add metadata and IDL for Smclic (Core Local Interrupt Controller) v1.0.
138+
139+
Closes #816
140+
```
141+
142+
```
143+
correct(ext): sctrclr belongs to Smctr/Sscntr extensions
144+
145+
The sctrclr instruction was improperly `definedBy` Smdbltrp
146+
147+
Closes #490
148+
```
149+
150+
```
151+
feat(ruby-db): add Sorbet type checking
152+
153+
Add Sorbet type signatures to ruby-db code, and run Sorbet type check in CI.
154+
155+
Closes #934
156+
```
157+
130158
=== Code review
131159

132160
All Pull Requests must go through the code review process.

0 commit comments

Comments
 (0)