Thanks for taking the time to contribute to this project!
There are multiple tasks you can do in order to help us, for example:
- fill an issue to report bugs or your specific needs
- contribute to existing issue
- write a PR to improve the project
All the important files are in the src directory.
In order to make a code contribution, create a fork of Ackee by clicking the "Fork" button on GitHub and cloning the repo to your local machine.
Please use the develop branch as a base for your contribution and make your changes on a new branch.
Ensure that you open an issue to discuss the changes before submitting a PR.
Once you're finished, push your branch to your repo and create a pull request!
ESlint is used for linting. It's recommended to add the corresponding extension to your editor. It's also possible to run the lint task with the following command:
$ npm run lintDuring development it is helpful to watch for file changes and automatically rebuild the files:
$ npm run watchTo produce a production build, run:
$ npm run build