Contributing to Ichnion
We want to make contributing to our projects as approachable and transparent as possible.
Code of Conduct#
The Ichnion Project has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
Our Development Process#
We use GitHub to sync code to and from our internal repository. We'll use GitHub to track issues and feature requests, as well as accept pull requests.
Pull Requests#
We actively welcome your pull requests.
- Fork the repo and create your branch from the development branch.
- If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- “sign off” your commits to indicate that you agree to the terms of the DCO.
Developer Certificate of Origin (DCO)#
For some projects, before we can include your contribution, you need to give us your permission. To indicate that you agree to the terms of the DCO, you “sign off” your contribution by adding a line with your name and e-mail address to every Git commit message:
In Sourcetree you can signoff commits automatically by selecting thes sign-off menu in the commit dialog.
Issues#
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. If possible please provide a minimal demo of the problem.
Coding Style#
- 2 spaces for indentation rather than tabs
- 80 character line length
- Run
npm run lintto conform to our lint rules
License#
By contributing to one of our projects, you agree that your contributions will be licensed
under the license indicated in the repositories LICENSE file.
References#
This document was adapted from the open-source contribution guidelines for Facebook's Draft