Skip to content

Commit d0ccf65

Browse files
Create CONTRIBUTING.md
1 parent 3fcae60 commit d0ccf65

File tree

1 file changed

+68
-0
lines changed

1 file changed

+68
-0
lines changed

CONTRIBUTING.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# multiform-validator - Contribution Guide
2+
3+
The multiform-validator is a powerful Multilanguage library for validating form fields in multiple languages. This guide describes the guidelines for contributing to the project efficiently and effectively.
4+
5+
## How to Contribute
6+
7+
1. **Fork the Repository**
8+
- Fork the multiform-validator repository to your GitHub account.
9+
10+
2. **Clone the Repository**
11+
- Clone the forked repository to your local environment:
12+
```
13+
git clone https://github.com/gabriel-logan/multiform-validator.git
14+
```
15+
16+
4. **Commit and Push**
17+
- Commit your changes and push them to the forked repository:
18+
```
19+
git add .
20+
git commit -m "Concise description of the changes"
21+
git push origin my-feature
22+
```
23+
24+
5. **Open a Pull Request (PR)**
25+
- Go to the forked repository on GitHub and open a PR to the main branch of the project.
26+
27+
## Contribution Guidelines
28+
29+
feat: Adds a new feature to the project. For example:
30+
31+
feat: Add controller for user management
32+
fix: Fixes an existing bug or issue. For example:
33+
34+
fix: Fix validation error in the controller
35+
refactor: Restructures existing code without changing its functionality. For example:
36+
37+
refactor: Rearrange methods in the controller for better readability
38+
docs: Updates the project's documentation. For example:
39+
40+
docs: Update documentation for the user controller
41+
style: Makes code style-related changes, such as formatting, indentation, etc. For example:
42+
43+
style: Format code in the controller according to project guidelines
44+
test: Adds or modifies tests in the project. For example:
45+
46+
test: Add tests for the user controller
47+
chore: Performs maintenance tasks or other activities not directly related to code. For example:
48+
49+
chore: Update project dependencies for compatibility with new versions
50+
perf: Makes performance improvements in the code. For example:
51+
52+
perf: Optimize data query in the controller
53+
revert: Reverts a previous change. For example:
54+
55+
revert: Revert changes in the controller due to implementation issues
56+
ci: Makes modifications related to continuous integration (CI) and deployment. For example:
57+
58+
ci: Configure CI pipeline to automatically test the controller
59+
60+
- Follow the coding standards of the language you're contributing to (JavaScript, TypeScript, Java, etc.).
61+
- Keep the code clean and readable.
62+
- Add tests for new functionalities or bug fixes.
63+
- Properly document the changes made, including updates to README if necessary.
64+
- Be respectful to other contributors and maintain a collaborative environment.
65+
66+
## License
67+
68+
By contributing to multiform-validator, you agree that your contributions will be licensed under the MIT license. Make sure you're familiar with the terms of this license.

0 commit comments

Comments
 (0)