Skip to content

Commit 0d3436f

Browse files
committed
docs: update contributing guidelines for commit message conventions
1 parent aea3553 commit 0d3436f

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

CONTRIBUTING.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The multiform-validator is a powerful Multilanguage library for validating form
1818
- Commit your changes and push them to the forked repository:
1919
```
2020
git add .
21-
git commit -m "Concise description of the changes"
21+
git commit -m "feat: concise description of the changes"
2222
git push origin my-feature
2323
```
2424
@@ -27,36 +27,36 @@ The multiform-validator is a powerful Multilanguage library for validating form
2727
2828
## Contribution Guidelines
2929
30-
feat: Adds a new feature to the project. For example:
30+
feat: adds a new feature to the project. For example:
3131
32-
feat: Add controller for user management
33-
fix: Fixes an existing bug or issue. For example:
32+
feat: add controller for user management
33+
fix: fixes an existing bug or issue. For example:
3434
35-
fix: Fix validation error in the controller
36-
refactor: Restructures existing code without changing its functionality. For example:
35+
fix: fix validation error in the controller
36+
refactor: restructures existing code without changing its functionality. For example:
3737
38-
refactor: Rearrange methods in the controller for better readability
39-
docs: Updates the project's documentation. For example:
38+
refactor: rearrange methods in the controller for better readability
39+
docs: updates the project's documentation. For example:
4040
41-
docs: Update documentation for the user controller
42-
style: Makes code style-related changes, such as formatting, indentation, etc. For example:
41+
docs: update documentation for the user controller
42+
style: makes code style-related changes, such as formatting, indentation, etc. For example:
4343
44-
style: Format code in the controller according to project guidelines
45-
test: Adds or modifies tests in the project. For example:
44+
style: format code in the controller according to project guidelines
45+
test: adds or modifies tests in the project. For example:
4646
47-
test: Add tests for the user controller
48-
chore: Performs maintenance tasks or other activities not directly related to code. For example:
47+
test: add tests for the user controller
48+
chore: performs maintenance tasks or other activities not directly related to code. For example:
4949
50-
chore: Update project dependencies for compatibility with new versions
51-
perf: Makes performance improvements in the code. For example:
50+
chore: update project dependencies for compatibility with new versions
51+
perf: makes performance improvements in the code. For example:
5252
53-
perf: Optimize data query in the controller
54-
revert: Reverts a previous change. For example:
53+
perf: optimize data query in the controller
54+
revert: reverts a previous change. For example:
5555
56-
revert: Revert changes in the controller due to implementation issues
57-
ci: Makes modifications related to continuous integration (CI) and deployment. For example:
56+
revert: revert changes in the controller due to implementation issues
57+
ci: makes modifications related to continuous integration (CI) and deployment. For example:
5858
59-
ci: Configure CI pipeline to automatically test the controller
59+
ci: configure CI pipeline to automatically test the controller
6060
6161
- Follow the coding standards of the language you're contributing to (JavaScript, TypeScript, Java, etc.).
6262
- Keep the code clean and readable.

0 commit comments

Comments
 (0)