Skip to content

Commit 2161cf9

Browse files
authored
Create CONTRIBUTING.md
1 parent ecfc3ab commit 2161cf9

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing to Modmail
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
If you are proposing new features, please discuss them with us in the [development server](https://discord.gg/etJNHCQ) before you start working on them!
12+
13+
## We Develop with Github
14+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
15+
16+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
17+
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:
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+
## Any contributions you make will be under the MIT Software License
27+
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.
28+
29+
## Report bugs using Github's [issues](https://github.com/kyb3r/modmail/issues)
30+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/kyb3r/modmail/issues/new); it's that easy!
31+
32+
## Write bug reports with detail, background, and sample code
33+
**Great Bug Reports** tend to have:
34+
35+
- A quick summary and/or background
36+
- Steps to reproduce
37+
- Be specific!
38+
- What you expected would happen
39+
- What actually happens
40+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
41+
42+
43+
## Use a Consistent Coding Style
44+
We use [black](https://github.com/python/black) for a unified code style.
45+
46+
## License
47+
By contributing, you agree that your contributions will be licensed under its MIT License.
48+
49+
## References
50+
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)