You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+23-3
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
4
4
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! ;)
6
6
7
7
## :+1: What we love to see
8
8
- 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
12
12
13
13
- No duplicate code block
14
14
- 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
17
16
- Decoupling is better than coupling
18
17
- Long but informative names are better than short but perplexing ones
19
18
- Numerous but small classes are better than few but very large ones
20
19
- 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`.
0 commit comments