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/slate-tools.git
Note: replace "your-username" with your Github handle
Install the project's dependencies:
npm install
Write some features.
Add some tests and make your change. Re-run the tests with:
npm run 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 made in the README.md.
If further documentation is needed please communicate this via Github Issues.
The CHANGELOG.md file is generated by the gem github_changelog_generator. Changelog will itemize changes between tags on GitHub.
The changelog is updated by the repo's maintainers since a personal access token with repository access is needed to handle GitHub's API call limits.
Note to maintainers: To update the changelog, install the gem and run github_changelog_generator in the root directory. Paste updates to the changelog in the tag notes, see example: v0.3.0 tag notes.