You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 18, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+18-7Lines changed: 18 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,32 +11,39 @@ We love your input! We want to make contributing to this project as easy and tra
11
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
12
13
13
## We Develop with Github
14
+
14
15
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
15
16
16
17
## We Use [Git Flow](https://atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
17
-

18
-
When contributing to this project, please make sure you follow this and name your branches appropriately!
18
+
19
+
\
20
+
When contributing to this project, please make sure you follow this and name your branches appropriately!
19
21
20
22
## All Code Changes Happen Through Pull Requests
21
-
Make sure you know how Git Flow works before contributing!
23
+
24
+
Make sure you know how Git Flow works before contributing!
22
25
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
23
26
24
27
1. Fork the repo and create your branch from `master` or `development` according to Git Flow.
25
-
2. Update the CHANGELOG.
26
-
3. If you've changed `core/*` or `bot.py`, mark changelog as "BREAKING" since plugins may break.
27
-
4. Make sure your code passes the lint checks.
28
-
5. Create Issues and pull requests!
28
+
1. Update the CHANGELOG.
29
+
1. If you've changed `core/*` or `bot.py`, mark changelog as "BREAKING" since plugins may break.
30
+
1. Make sure your code passes the lint checks.
31
+
1. Create Issues and pull requests!
29
32
30
33
## Any contributions you make will be under the GNU Affero General Public License v3.0
34
+
31
35
In short, when you submit code changes, your submissions are understood to be under the same [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.en.html) that covers the project. Feel free to contact the maintainers if that's a concern.
32
36
33
37
## Report bugs using [Github Issues](https://github.com/modmail-dev/modmail/issues)
38
+
34
39
We use GitHub issues to track public bugs. Report a bug by [opening a new Issue](https://github.com/modmail-dev/modmail/issues/new); it's that easy!
35
40
36
41
## Find pre-existing issues to tackle
42
+
37
43
Check out our [unstaged issue tracker](https://github.com/modmail-dev/modmail/issues?q=is%3Aissue+is%3Aopen+-label%3Astaged) and start helping out!
38
44
39
45
Ways to help out:
46
+
40
47
- Help out new members
41
48
- Highlight invalid bugs/unsupported use cases
42
49
- Code review of pull requests
@@ -45,6 +52,7 @@ Ways to help out:
45
52
- Create a pull request to resolve the issue!
46
53
47
54
## Write bug reports with detail, background, and sample code
55
+
48
56
**Great Bug Reports** tend to have:
49
57
50
58
- A quick summary and background
@@ -55,10 +63,13 @@ Ways to help out:
55
63
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
56
64
57
65
## Use a Consistent Coding Style
66
+
58
67
We use [black](https://github.com/python/black) for a unified code style.
59
68
60
69
## License
70
+
61
71
By contributing, you agree that your contributions will be licensed under its MIT License.
62
72
63
73
## References
74
+
64
75
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