👍🎉 Thanks for contributing! 🎉👍
We expect contributors follow code of conduct. All conversations and discussions on GitHub (issues, pull requests) must be respectful and harassment-free.
All issues are ready for grabs.
In case of doubt, ask a owner of this repository by mentioning on the issue.
Refactoring code, e.g., improving the code without modifying the behavior is an area that can probably be done based on intuition and may not require much communication to be merged.
Fixing bugs may also not require a lot of communication, but the more, the better. Please surround bug fixes with ample tests. Bugs are magnets for other bugs. Write tests near bugs!
Building features is the area which will require the most communication and/or negotiation. Every feature is subjective and open for debate. If your feature involves user-facing design changes, please provide a mockup first so we can all get on the same page. As always, when in doubt, ask!
- Make sure you have installed Node
- Fork repository
- Create a branch, naming it either a feature or bug:
git checkout -b feature/that-new-featureorbug/fixing-that-bug - Run
npm startto see your result locally. - Run Jest tests with command
npm run test. Add new test if its needed. - Run TSLint with command
npm run lint. - Code and commit your changes. Bonus points if you write a good commit message:
git commit -m 'Add some feature' - Push to the branch:
git push origin feature/that-new-feature - Create a pull request for your branch 🎉
If you find any bugs or have some ideas for improvenments. Please check issues page.