Formation | A rule-based JavaScript Form Validation Library

Rule-based, cross-browser, client side HTML form validation library written in JavaScript

---

Project maintained by ozzyogkush Hosted on GitHub Pages — Theme by mattgraham

Contributing to Formation

Requirements for Development

• Git - for version control (I recommend using the SourceTree program by Atlassian, as it rules)
• NodeJS - required for development and release builds (v6.3 or higher)
• yarn - a better package manager than npm
• Grunt - to run tests and create builds.

After installing NodeJS (and its package manager yarn), run yarn install to install dependencies.

Workflow

This project uses the Github Flow. We will accept pull requests from branches (other than master) on your own repository. All pull requests will be code reviewed. New features must include, at minimum, unit test cases. Unit tests must also be updated for any changes to existing features.

1. Fork your own copy of the the Formation repository to your GitHub account
2. Checkout the master branch in your fork and pull the latest changes from upstream master
3. Create a new branch from master
4. Run yarn install to add all dependencies
5. Add your changes and unit tests
6. Update Documentation
7. Open a terminal to your project folder
8. Run automated tests with grunt test
9. When ready, run grunt build to create distribution files
10. Commit changes and push your branch
11. Create a pull request of your forked branch into the Formation master branch

Grunt tasks:

• dev - JSHint and non-minified build
• unitTests - run all tests with code coverage
• unitTests:mocha - run all tests without code coverage
• test - JSHint, non-minified build, run all tests with code coverage
• build - JSHint, non-minified build, run all tests with code coverage, minified build

Tools Used in Development and Testing

The below tools will be installed as dependencies:

• JSHint/JSLint - used for ensuring JS files are syntactically correct
• Mocha - testing framework
• Chai - provides assert, expect, should functionality for Mocha
• Istanbul - works with Mocha to provides code coverage for testing results
• Sinon - used for spies, stubs, mocks, etc.
• Webpack - for building static assets in builds