To submit a bug report, please open an issue on the Github issue tracker (here). Please make sure that you are not filing a duplicate issue.
To contribute to the codebase, you need to create pull requests with the changes you want to make. Here is a general flow of how to submit a pull request -
- Fork this repository from Github.
- Clone your version of the repository into your local development environment.
- Set up the project.
- Checkout a new branch with proper name.
$ git checkout -b <new-branch-name>
- Make the changes you want.
- Add and commit the changed files with a proper commit message.
$ git add <files-to-commit> $ git commit -m <your-commit-message>
- Push your local branch
$ git push origin <new-branch-name>
- Go to the repo on Github and create a pull request by selecting proper branches.
- Done 🎉.
The project uses yarn for dependency management.
$ yarn
$ yarn start
$ yarn build