👍🎉 First off, thanks for taking the time to contribute! 🎉👍
This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to uphold this code.
The following is a set of guidelines for contributing to toblender. These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request.
- You can create an issue here,
but before doing that please read the notes below and include as many details as
possible with your report. If you can, please include:
- The version of toblender you are using
- The operating system you are using
- If applicable, what you were doing when the issue arose and what you expected to happen
- Other things that will help resolve your issue:
- Screenshots and animated GIFs
- Error output that appears in your terminal, dev tools or as an alert
- Perform a cursory search to see if a similar issue has already been submitted
- Include screenshots and animated GIFs in your pull request whenever possible.
- Follow the coding style defined in .eslintrc.json.
- Write documentation in Markdown.
- Fork it!
- Clone your fork
- Install development dependencies
cd toblender;
npm install;
- Create your feature branch:
git checkout -b my-new-feature;
- Add add your new code
- Run the tests:
npm test;
- Commit your changes:
git commit -am 'Add some feature';
- Push to the branch:
git push origin my-new-feature;
- Submit a pull request 🐶