Skip to content

How to contribute?

Contributors and pull requests are welcome. Feel free to contact us for any questions.

Contributing, in a nutshell

For more detailed information about how to contribute, please check the rest of this page.

In a nutshell:

  1. Get the latest source git clone -b next https://github.com/autoNumeric/autoNumeric.git && cd autoNumeric && yarn install
  2. Make you changes
  3. Lint, build, and run tests yarn lint && yarn build && yarn test
    • If you encounter any linting problems, you can try to automatically fix those with yarn lintfix
  4. Create a pull request, and we'll check it out as soon as possible!

Again, be sure to check the following guidelines for more details.

Also, feel free to follow our RSS feeds on master and next to keep up with the latest commits.

Junior jobs 🏅

Every contribution are welcomed, whatever their sizes.

If you want to contribute to a dynamic and welcoming open-source project, be sure to check our easy-to-start-with junior jobs, either by checking the issues for the tag Junior jobs, or by searching for the //TODO and //FIXME strings directly in the source (there are plenty awaiting for you right now!).

Happy coding :>

Get the latest source

git clone -b next https://github.com/autoNumeric/autoNumeric.git
# or the following if you are authentified on Github:
# `git clone -b next git@github.com:autoNumeric/autoNumeric.git`

Make your changes

Note

You can use either npm or yarn for running the install/build scripts. We'll use yarn in the following examples.

First things first, in order to be able to compile the ES6 source to something that can be interpreted by the browsers, and get the tools (linter, test runners, etc.) used by the developers, you need to install them by doing : 

cd autoNumeric
yarn install

Hint

You need to have yarn installed before executing this command.
You can install yarn globally by doing npm install -g yarn as root.

Once you made your changes, you can build the library with : 

yarn build
This will generate the autoNumeric.js and autoNumeric.min.js files in the dist folder, that you'll then be able to use in the browsers.

If you want to clean the generated .js and .min.js files as well as development specific ones like coverage and log files, use : 

yarn run clean

Warning

Do not use yarn clean as it's a different command entirely.

Run the mandatory tools for linting and testing

We strive to keep the tests green at all times. Hence whenever you change the source, be sure to:

  1. Write at least 2 tests for each change:
    • One that validate your changes
    • One that invalidate your changes
  2. Make sure all tests passes on all supported browsers (PhantomJS, Firefox, and Chrome)
    • Write unit tests and end-to-end tests
  3. Make sure eslint does not return any errors regarding the coding style.

Warning

Pull requests that turns the tests red 🟥, or that do not provide new tests for new features will not be accepted.

How to test?

Tests must always be green ✅ before pushing. Any commit that make the tests fails will be ignored.
To run the tests, you have multiple options: 

# Run unit testing as well as end-to-end testing
yarn test

# Run unit testing only
yarn test:unit

# Run end-to-end testing only
yarn test:e2e

# Run unit testing only...
yarn test:unitp   # ...with PhantomJS only
yarn test:unitf   # ...with Firefox only
yarn test:unitc   # ...with Chrome only

Behind the scene, all unit and end-to-end tests are written with Jasmine.
Karma is used to run the unit tests, while Webdriver.io is used to run end-to-end tests.

How to lint?

Linting allow us to keep a coherent code style in all the source files.
In order to check that everything is well formatted, run eslint with: 

yarn lint
If any errors are shown, you can try to automatically correct them by running: 
# Use the path of the faulty file to fix only this particular file:
./node_modules/eslint/bin/eslint.js --fix src/AutoNumeric.js

# Or try to fix all errors in all files once with
yarn lintfix

How to push?

Every changes that you pushed in its own branch in your personal AutoNumeric repository copy should be based on the latest version of the next branch (the development branch).

When you create a pull request, make sure to push against the next branch.

Please try to break down your pull requests and commits into small and manageable entities, in order:

  • to make them easier to process, and more importantly
  • to keep each logical set of changes in its own commit.

Additionally, your commits must not contain any generated files (ie. files built in the /dist/ directory, or logs).

Important changes regarding the generated dist files

Since the version 4.1.3, the generated dist files (ie. autoNumeric.js and autoNumeric.min.js) are not pushed into the repository anymore.

However, all tagged commits are now automatically built and published on npm.

This means if you want to download the minified library directly, you need to use npm to install it (yarn add autonumeric or npm install autonumeric).