contrubuting
swadhinbiswas committed 2 years ago
67fc0f7
1 parent f6a6aa6
commit 67fc0f7
1 file changed
+50 -0
Showing 1 changed file+50-0
▼Contributing.md
+50-0
| @@ -0,0 +1,50 @@ | ||
1 | +# Contributing to Transcriptase | |
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 | +## Report bugs using Github's [issues](https://github.com/professoridx/Project-Phoenix/issues) | |
27 | +We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy! | |
28 | + | |
29 | +## Write bug reports with detail, background, and sample code | |
30 | +[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. | |
31 | +**Great Bug Reports** tend to have: | |
32 | + | |
33 | +- A quick summary and/or background | |
34 | +- Steps to reproduce | |
35 | + - Be specific! | |
36 | +- What you expected would happen | |
37 | +- What actually happens | |
38 | +- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work) | |
39 | + | |
40 | +People *love* thorough bug reports. I'm not even kidding. | |
41 | + | |
42 | +## Use a Consistent Coding Style | |
43 | + | |
44 | + | |
45 | + | |
46 | + | |
47 | +## License | |
48 | +By contributing, you agree that your contributions will be licensed under its MIT License. | |
49 | + | |
50 | +## References | |
0 | 51 | |