Skip to content

Commit 62c39a4

Browse files
authored
Create CONTRIBUTING.md
1 parent 9dbb3f3 commit 62c39a4

1 file changed

Lines changed: 48 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contributing to Checkable TextView
2+
We love your input! 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+
## Any contributions you make will be under the MIT Software License
24+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
25+
26+
## Write bug reports with detail, background, and sample code
27+
28+
**Great Bug Reports** tend to have:
29+
30+
- A quick summary and/or background
31+
- Steps to reproduce
32+
- Be specific!
33+
- Give sample code if you can.
34+
- What you expected would happen
35+
- What actually happens
36+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
37+
38+
People *love* thorough bug reports. I'm not even kidding.
39+
40+
## Use a Consistent Coding Style
41+
42+
- Use consistent coding style for uniform coding standard and readibility.
43+
44+
## License
45+
By contributing, you agree that your contributions will be licensed under its MIT License.
46+
47+
## References
48+
This document was adapted from the open-source contribution guidelines template [Good-CONTRIBUTING](https://gist.github.com/PurpleBooth/b24679402957c63ec426)

0 commit comments

Comments
 (0)