We ❤️ pull requests. If you'd like to fix a bug, contribute a feature or just correct a typo, please feel free to do so, as long as you follow our Code of Conduct.
If you're thinking of adding a big new feature, consider opening an issue first to discuss it to ensure it aligns to the direction of the project (and potentially save yourself some time!).
To start working on the codebase, first fork the repo, then clone it:
git clone [email protected]:your-username/javascript-utilities.git
Note: replace "your-username" with your Github handle
Install the project's dependencies (make sure you first have yarn installed):
yarn
Write some features.
Add some tests and make your change. Re-run the tests with:
yarn test
If your change affects how people use the project (i.e. adding or
changing arguments to a function, adding a new function, changing the
return value, etc), please ensure the documentation is also updated to
reflect this. Documentation is in the README.md if further documentation is needed please communicate via Github Issues.
Please make sure you update CHANGELOG.md with a high-level description of any changes you make. The format is based on Keep a Changelog.
The yarn version command can be used to create a new version. This project adheres to Semantic Versioning.