We love pull requests from everyone. By participating in this project, you agree to abide by the axax code of conduct.
Make sure you have a recent version of nodejs (10.x+)
Fork the repo:
git clone git@github.com:jamiemccrindle/axax.git
Set up your machine:
yarn install
Make sure the tests pass:
yarn lint
yarn test
Make your change. Write tests. Update the API documentation We use prettier to format the code. Make the tests pass:
yarn lint
yarn test
Write a good commit message. Push to your fork. Submit a pull request.
Wait for us. We try to at least comment on pull requests within two business days. We may suggest changes.