-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b8ac651
commit 62cc112
Showing
1 changed file
with
60 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
# multiform-validator - Contribution Guide | ||
|
||
The multiform-validator is a powerful JavaScript library for validating form fields in multiple languages. This guide describes the guidelines for contributing to the project efficiently and effectively. | ||
|
||
## How to Contribute | ||
|
||
1. **Fork the Repository** | ||
- Fork the multiform-validator repository to your GitHub account. | ||
|
||
2. **Clone the Repository** | ||
- Clone the forked repository to your local environment: | ||
``` | ||
git clone https://github.com/your-username/multiform-validator.git | ||
``` | ||
3. **Install Dependencies** | ||
- Navigate to the project directory and install the dependencies: | ||
``` | ||
cd multiform-validator | ||
npm install | ||
``` | ||
4. **Create a Branch** | ||
- Create a branch to work on your changes: | ||
``` | ||
git checkout -b my-feature | ||
``` | ||
5. **Make Changes** | ||
- Implement your improvements, fixes, or new features. | ||
6. **Test** | ||
- Ensure all functionalities are working correctly. | ||
- Run automated tests if applicable: | ||
``` | ||
npm test | ||
``` | ||
7. **Commit and Push** | ||
- Commit your changes and push them to the forked repository: | ||
``` | ||
git add . | ||
git commit -m "Concise description of the changes" | ||
git push origin my-feature | ||
``` | ||
8. **Open a Pull Request (PR)** | ||
- Go to the forked repository on GitHub and open a PR to the main branch of the project. | ||
## Contribution Guidelines | ||
- Follow the coding standards of the language you're contributing to (JavaScript, TypeScript, etc.). | ||
- Keep the code clean and readable. | ||
- Add tests for new functionalities or bug fixes. | ||
- Properly document the changes made, including updates to README if necessary. | ||
- Be respectful to other contributors and maintain a collaborative environment. | ||
## License | ||
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. |