Welcome to validator.js repository!! We appreciate your interest in contributing to this open library and for helping our community grow.
In general, we follow the "fork-and-pull" Git workflow.
- Fork the repository on GitHub
- Clone the project to your local machine
- Work on your fork
- Make your changes and additions
- Most of your changes should be focused on src/ and test/ folders and/or README.md.
- Files such as validator.js, validator.min.js and files in lib/ folder are autogenerated when running tests (npm test) and need not to be changed manually.
- Change or add tests if needed
- Run tests and make sure they pass
- Add changes to README.md if needed
- Make your changes and additions
- Commit changes to your own branch
- Make sure you merge the latest from "upstream" and resolve conflicts if there is any
- Repeat step 3(3) above
- Push your work back up to your fork
- Submit a Pull request so that we can review your changes
Tests are using mocha. To run the tests use:
$ npm testWe welcome financial contributions on our open collective.
You can opt to become a backer or a sponsor and help our project sustain over time.
Thank you to the people who have already contributed:
