While we love contributions, we also need to ensure that our library is of great quality. Thus we require you to follow some simple guidelines when you're submitting your contributions.
Before opening an issue, please search the issue tracker to make sure your issue hasn’t already been reported.
Visit the issue tracker to find a list of open issues that need attention.
Fork, then clone the repo:
git clone https://github.com/your-username/chromosome-js.git
To run tests:
yarn test
Before submitting a PR check for stylistic errors by linting the project:
yarn lint
To build run:
yarn run build
Do you know about Genetic Algorithms and want to explain some concept? Are you eager to help us improve the language that we use? Do you have any doubt or something that we could make clearer? Please open an issue starting with [Documentation]
You can help ChromosomeJS to extend the utils functions library, define a better API to interact with it or simply make a feature request. Just open an issue starting with [Utils].
To help ChromosomeJS offer a more performant framework, improve the API, extend it to fit other Evolutionary Algorithms you could start by opening an issue starting with [Framework].
For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don’t want you to waste your efforts on a pull request that we won’t want to accept.
On the other hand, sometimes the best way to start a conversation is to send a pull request. Use your best judgement!
- Open a new issue in the Issue tracker
- Fork the repo
- Create a new feature branch based off the
masterbranch - Create breaking test(s) before implementing any fixes or functionality
- Make your changes
- Submit a pull request, referencing any issue that it resolves
Thank you, we 💜 your contributions!
*Contribute template from redux-json-api