Skip to content

Commit 45b332d

Browse files
committed
contributing MD file
1 parent 22c8d60 commit 45b332d

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to Transcriptase
2+
We love your input! We want to make contributing to Swell 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+
9+
## We Develop with Github
10+
We use Github to host code, to track issues and feature requests, as well as accept pull requests.
11+
12+
## All Code Changes Happen Through Pull Requests
13+
Pull requests are the best way to propose changes to Swell. We actively welcome your pull requests:
14+
15+
1. Fork the repo and create your branch from `dev`.
16+
2. If you've added code that should be tested, add tests.
17+
3. If you've changed APIs, update the documentation.
18+
4. Ensure the test suite passes.
19+
5. Make sure your code lints.
20+
6. Issue that pull request!
21+
22+
## Any contributions you make will be under the MIT Software License
23+
In short, when you submit code changes, your submissions are understood to be under the same that covers the project. Feel free to contact the maintainers if that's a concern.
24+
25+
## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
26+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/open-source-labs/Swell/issues); it's that easy!
27+
28+
## Write bug reports with detail, background, and sample code
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. Include sample code that *anyone* can run to reproduce what you are experiencing
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+
## Use a Consistent Coding Style
42+
* 2 spaces for indentation rather than tabs
43+
* You can try running `npm run lint` for style unification
44+
45+
## License
46+
By contributing, you agree that your contributions will be licensed under its MIT License.
47+
48+
## References
49+
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)