|
| 1 | +# Contributing to chicio.github.com |
| 2 | +We love your input! :heart: We want to make contributing to this project as easy and transparent as possible, whether it's: |
| 3 | + |
| 4 | +- Reporting a bug |
| 5 | +- Discussing the current state of the code |
| 6 | +- Submitting a fix |
| 7 | +- Proposing new features |
| 8 | +- Becoming a maintainer |
| 9 | + |
| 10 | +## We Develop with Github |
| 11 | +We use github to host code, to track issues and feature requests, as well as accept pull requests. |
| 12 | + |
| 13 | +## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests |
| 14 | +Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests: |
| 15 | + |
| 16 | +1. Fork the repo and create your branch from `master`. |
| 17 | +2. If you've added code that should be tested, add tests. |
| 18 | +3. If you've changed APIs, update the documentation. |
| 19 | +4. Ensure the test suite passes. |
| 20 | +5. Make sure your code lints. |
| 21 | +6. Issue that pull request! |
| 22 | + |
| 23 | +## Report bugs using Github's [issues](https://github.com/chicio/chicio.github.com/issues) |
| 24 | +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/chicio/chicio.github.com/issues/new/choose "opening an issue"); it's that easy! :purple_heart: |
| 25 | + |
| 26 | +**Great Bug Reports** tend to have: |
| 27 | +- A quick summary and/or background |
| 28 | +- Steps to reproduce |
| 29 | + - Be specific! |
| 30 | + - Give sample code if you can. |
| 31 | +- What you expected would happen |
| 32 | +- What actually happens |
| 33 | +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) |
| 34 | + |
| 35 | +People *love* :cupid: beautiful bug reports. |
| 36 | + |
| 37 | +# Code review process |
| 38 | +We will review every pull request in detail and eventually start discussions about the implementation. We will reject pull request that doesn't respect the code style described below. |
| 39 | + |
| 40 | +## Coding Style |
| 41 | +* 4 spaces for indentation rather than tabs |
| 42 | +* 120 character line length |
| 43 | +* Add author name to new files |
| 44 | + |
| 45 | +## License |
| 46 | +By contributing, you agree that your contributions will be licensed under its [MIT License](https://github.com/chicio/chicio.github.com/blob/master/LICENSE.md). |
| 47 | + |
| 48 | +## References |
| 49 | +This document was adapted from the open-source contribution guidelines for [Facebook's contributing guidelines](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md). |
0 commit comments