Skip to content

Commit 5855904

Browse files
author
Natan Vieira
authored
chore: create contributing guidelines
1 parent 7b7165c commit 5855904

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

CONTRIBUTING.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributing to Katan
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+
## Any contributions you make will be under the MIT Software License
14+
In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.
15+
16+
## Code changes happen through Pull Requests
17+
Pull requests are the best way to propose changes to the codebas. We actively welcome your pull requests:
18+
19+
1. Fork the repo and create your branch from `master`.
20+
2. If you've added code that should be tested, add tests.
21+
3. If you've changed APIs, update the documentation.
22+
4. Ensure the test suite passes.
23+
5. Make sure your code lints.
24+
6. Issue that pull request!
25+
26+
## Write bug reports with detail, background, and sample code
27+
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
28+
29+
**Great Bug Reports** tend to have:
30+
31+
- A quick summary and/or background
32+
- Steps to reproduce
33+
- Be specific!
34+
- Give sample code if you can.
35+
- What you expected would happen
36+
- What actually happens
37+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
38+
39+
People *love* thorough bug reports. I'm not even kidding.
40+
41+
## Consistent coding style
42+
* Tabs for indentation rather spaces.
43+
* 100 character line length
44+
45+
## License
46+
By contributing, you agree that your contributions will be licensed under its MIT License.

0 commit comments

Comments
 (0)