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.
First, run the development server:
npm run dev
# or
yarn dev
# or
pnpm dev
# or
bun dev
Open http://localhost:3000 with your browser to see the result.
-
Fork the Repository
- Fork the multiform-validator repository to your GitHub account.
-
Clone the Repository
- Clone the forked repository to your local environment:
git clone https://github.com/gabriel-logan/multiform-validator.git
- Clone the forked repository to your local environment:
-
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
- Commit your changes and push them to the forked repository:
-
Open a Pull Request (PR)
- Go to the forked repository on GitHub and open a PR to the main branch of the project.
feat: Adds a new feature to the project. For example:
feat: Add controller for user management fix: Fixes an existing bug or issue. For example:
fix: Fix validation error in the controller refactor: Restructures existing code without changing its functionality. For example:
refactor: Rearrange methods in the controller for better readability docs: Updates the project's documentation. For example:
docs: Update documentation for the user controller style: Makes code style-related changes, such as formatting, indentation, etc. For example:
style: Format code in the controller according to project guidelines test: Adds or modifies tests in the project. For example:
test: Add tests for the user controller chore: Performs maintenance tasks or other activities not directly related to code. For example:
chore: Update project dependencies for compatibility with new versions perf: Makes performance improvements in the code. For example:
perf: Optimize data query in the controller revert: Reverts a previous change. For example:
revert: Revert changes in the controller due to implementation issues ci: Makes modifications related to continuous integration (CI) and deployment. For example:
ci: Configure CI pipeline to automatically test the controller
- Follow the coding standards of the language you're contributing to (JavaScript, TypeScript, Java, 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.
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.