Skip to content

Commit 718c747

Browse files
committed
docs(contributing): update contributing guidelines
Add instruction on pull request naming and commit format
1 parent 019045b commit 718c747

1 file changed

Lines changed: 84 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,87 @@
1-
**Internationalization**
1+
## Pull Request Naming Guidelines
2+
3+
To keep the repository organized and to make it easier to understand the purpose of each pull request, the project follows these pull request naming conventions:
4+
5+
### Format
6+
7+
Each pull request name should include a type and a short description:
8+
9+
`<type>: <short-description></type>`
10+
11+
### Types
12+
13+
Use one of the following types:
14+
15+
- **feat**: A new feature
16+
- **fix**: A bug fix
17+
- **docs**: Documentation only changes
18+
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
19+
- **refactor**: A code change that neither fixes a bug nor adds a feature
20+
- **perf**: A code change that improves performance
21+
- **test**: Adding missing or correcting existing tests
22+
- **build**: Changes that affect the build system or external dependencies
23+
- **ci**: Changes to the CI configuration files and scripts
24+
- **chore**: Other changes that don't modify src or test files
25+
- **revert**: Reverts a previous commit
26+
27+
### Examples
28+
29+
- `feat: add login feature`
30+
- `fix: bug in authentication`
31+
- `docs: update readme`
32+
- `chore: cleanup dependencies`
33+
- `refactor: improve parser`
34+
35+
By following these guidelines, you help ensure that the branches are easy to understand and manage.
36+
37+
## Commit Message Guidelines
38+
39+
This project follows the commit message conventions set by [Conventional Commits](https://www.conventionalcommits.org/).
40+
41+
### Commit Message Format
42+
43+
Each commit message should include a type, a scope (optional), and a subject:
44+
45+
`<type>(<scope>): <subject></subject></scope></type>`
46+
47+
#### Type
48+
49+
Must be one of the following:
50+
51+
- **feat**: A new feature
52+
- **fix**: A bug fix
53+
- **docs**: Documentation only changes
54+
- **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
55+
- **refactor**: A code change that neither fixes a bug nor adds a feature
56+
- **perf**: A code change that improves performance
57+
- **test**: Adding missing or correcting existing tests
58+
- **build**: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
59+
- **ci**: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
60+
- **chore**: Other changes that don't modify src or test files
61+
- **revert**: Reverts a previous commit
62+
63+
#### Subject
64+
65+
The subject contains a succinct description of the change:
66+
67+
- Use the imperative, present tense: "change" not "changed" nor "changes"
68+
- Do not capitalize the first letter
69+
- Do not end the subject with a period
70+
71+
### Examples
72+
73+
```plaintext
74+
feat(parser): add support for new weather condition
75+
76+
fix(translation): correct French translation for 'clear sky'
77+
78+
docs(contributing): add commit message guidelines
79+
```
80+
81+
By following these guidelines, you help ensure that the project remains consistent and easy to understand.
82+
83+
84+
## Internationalization
285

386
If you are willing to add a new language or complete an existing language, please use https://crwd.in/metarParser to register and contribute.
487
Once a language is complete at 100%, open an issue so the translation can be added to the project.

0 commit comments

Comments
 (0)