Skip to content

Commit 56c29c8

Browse files
authored
docs: update CONTRIBUTING.md
1 parent 46b58a6 commit 56c29c8

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

CONTRIBUTING.md

+23-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
44

5-
Above all, Danta(or Danta, 旦挞) is the source part of an application hosted by Github. We do not want to set a lot of guidelines or something else, just judge your contribution by your heart! ;)
5+
Above all, Danta (or 旦挞) is the source part of an application hosted by Github. We do not want to set a lot of guidelines or something else, just judge your contribution by your heart! ;)
66

77
## :+1: What we love to see
88
- Codes linted with [Prettier](https://prettier.io/), or similar tools provided by your IDE
@@ -12,12 +12,32 @@ Above all, Danta(or Danta, 旦挞) is the source part of an application hosted b
1212

1313
- No duplicate code block
1414
- No confusing name for variables, methods and classes
15-
- `get` for getting something locally, `load` for getting something remotely, `save` for setting something locally
16-
- No lengthy and multi-function method body. Keep it under 10 lines if possible
15+
- No lengthy and multi-function method body
1716
- Decoupling is better than coupling
1817
- Long but informative names are better than short but perplexing ones
1918
- Numerous but small classes are better than few but very large ones
2019
- Private is better than public. Use `_` in your naming as much as possible!
20+
- **A compliant commit message!** Quick flashback:
21+
```
22+
<action>: <description>
23+
24+
<details>
25+
```
26+
27+
`<action>` shall be one of:
28+
- `feat`: Implement new features.
29+
- `fix`: Fix real bugs in the code. This means that corrections to documents, spelling, etc., do not count as fixes.
30+
- `docs`: Changes to documentation (not include translation texts).
31+
- `update`: Update translation texts.
32+
- `upgrade`: Upgrade dependency, Flutter SDK version, etc.
33+
- `change` / `misc`: Changes to the code that cannot be categorized. For example, modifying the color of a button or adjusting the layout boundaries.
34+
- `style`: Changes to the code style, such as running the formatting tools, fixing typos, modifying variable names, removing unnecessary whitespace, etc.
35+
- `refactor`: Refactor the code logic, without adding new features or fixing bugs.
36+
- `chore`: Changes to the build process or auxiliary tool scripts.
37+
- `perf`: Improve runtime performance.
38+
39+
There are also some other common actions, such as `add`, but they are discouraged in this project because they have been subdivided into other action types, such as `feat`.
40+
2141

2242
## :-1: What we dislike to see
2343
- Confusing codes or messy format

0 commit comments

Comments
 (0)