Skip to content

Commit d0a062e

Browse files
committed
docs: explain conventional commit in contribute.md
Signed-off-by: Yi Huang <yi@secondstate.io>
1 parent 5ca9782 commit d0a062e

File tree

1 file changed

+39
-5
lines changed

1 file changed

+39
-5
lines changed

docs/contribute/contribute.md

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ sidebar_position: 8
1010
* [Ask for Help](#ask-for-help)
1111
* [Pull Request Lifecycle](#pull-request-lifecycle)
1212
* [Development Environment Setup](#development-environment-setup)
13-
* [Sign Your Commits](#sign-your-commits)
13+
* [Commit Format](#commit-format)
1414
* [Pull Request Checklist](#pull-request-checklist)
1515

1616
Welcome! We are glad that you want to contribute to our project! 💖
@@ -118,9 +118,43 @@ If you use an operating system older than Ubuntu 20.04, please use our [special
118118

119119
To build WasmEdge from the source, please refer to: [Build WasmEdge from source](/category/build-wasmedge-from-source).
120120

121-
## Sign Your Commits
121+
## Commit Format
122122

123-
### DCO
123+
The commit messages should follow [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/).
124+
125+
A valid commit should look like this:
126+
127+
```
128+
<type>: <short description of the change>
129+
130+
<optional detailed description>
131+
132+
Signed-off-by: Your Name <your.email@example.com>
133+
```
134+
135+
Please check the full specification from [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/#specification).
136+
137+
::: note
138+
139+
See [@commitlint/@config-conventional] for allowed `<type>` values.
140+
141+
:::
142+
143+
An example commit message:
144+
145+
```
146+
docs: updates Contribution Guide
147+
148+
Signed-off-by: Alice Chen <alice.chen@example.com>
149+
```
150+
151+
::: note
152+
153+
WasmEdge has enforced conventional commit starting from Apr 9, 2025, see [WasmEdge#3850](https://github.com/WasmEdge/WasmEdge/pull/3850).
154+
155+
:::
156+
157+
### DCO - Sign Your Commits
124158

125159
Licensing is important to open source projects. It provides some assurances that
126160
the software will continue to be available based under the terms that the
@@ -132,7 +166,7 @@ have the right to contribute the code you are submitting to the project.
132166
You sign-off by adding the following to your commit messages. Your sign-off must
133167
match the git user and email associated with the commit.
134168

135-
This is my commit message
169+
docs: this commit updates something at somedoc.md
136170

137171
Signed-off-by: Your Name <your.name@example.com>
138172

@@ -143,7 +177,7 @@ Git has a `-s` command line option to do this automatically:
143177
If you forgot to do this and have not yet pushed your changes to the remote
144178
repository, you can amend your commit with the sign-off by running
145179

146-
git commit --amend -s
180+
git commit --amend -s
147181

148182
## Pull Request Checklist
149183

0 commit comments

Comments
 (0)