Thanks for taking the time to contribute to brain.js. Follow these guidelines to make the process smoother:
-
Clone
master
branch -
One feature per pull request. Each PR should have one focus, and all the code changes should be supporting that one feature or bug fix. Using a separate branch for each feature should help you manage developing multiple features at once.
-
Add/update a test for the feature or fix, if possible. To run these tests:
npm run test # run tests
-
This repository uses
.editorconfig
,eslint
(airbnb
) andprettier
for linting and formating to make coding style consistent throughout the repository, which will automatically run on gitcommit
. -
Please do not run build/dist script and do not bump version number for the script. These things will be handled by the maintainers when necessary.