Skip to content

Commit 5a24f17

Browse files
authored
Create CONTRIBUTING.md
1 parent b82ba65 commit 5a24f17

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Contributing
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+
## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
24+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
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 I wrote, 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. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing
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+
## References
42+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md)

0 commit comments

Comments
 (0)