Skip to content

Commit 63ce29c

Browse files
committed
docs: add CONTRIBUTING.md
Signed-off-by: Feifan He <feifan@codeweavers.com>
1 parent 2acf75a commit 63ce29c

2 files changed

Lines changed: 30 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
AI must not be used to generate code for contributions to this project.

CONTRIBUTING.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
2+
# Contributing to DXMT
3+
4+
## Commit Messages
5+
6+
We use semantic commit messages.
7+
8+
Format: `<type>(<scope>): <subject>`
9+
10+
Valid types:
11+
- feat: A newly added feature
12+
- fix: Just a fix
13+
- refactor: Any changes to the implementation that do not introduce new functionality
14+
- chore: Any changes to the code that do not change the implementation (e.g. formatting, adding comments)
15+
- docs: For documentation only (typically .md files)
16+
- build: For build script only
17+
- ci: For CI script only
18+
19+
The scope can be any sub-directory in `src/`. If a patch involves multiple scopes, separate them by comma `, `. Scopes can be omitted if there are more than 4, but please try your best to constrain your changes into one single scope. For docs/build/ci, no need to add scope.
20+
21+
The subject is a setence describing the change. Do not capitalize the first letter.
22+
23+
And most importantly, please **sign off** your commit with your legal name.
24+
25+
## AI Policy
26+
27+
We cannot accept contributions made or co-authored by AI/LLM (Large Language Model).
28+
29+
You are still free to use AI to do your own research and share your findings with others (including the developers, but please don't create a PR).

0 commit comments

Comments
 (0)