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
Copy file name to clipboardexpand all lines: .github/CONTRIBUTING.md
+8-9
Original file line number
Diff line number
Diff line change
@@ -15,33 +15,32 @@ We use GitHub to host code, to track issues and feature requests, as well as acc
15
15
16
16
## We Use [Git Flow](https://atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
17
17

18
-
When contributing to this project please make sure you follow this and name your branches appropriately!
18
+
When contributing to this project, please make sure you follow this and name your branches appropriately!
19
19
20
20
## All Code Changes Happen Through Pull Requests
21
21
Make sure you know how Git Flow works before contributing!
22
22
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
23
23
24
24
1. Fork the repo and create your branch from `master` or `development` according to Git Flow.
25
-
2. If you've added code that should be tested, add tests.
26
-
3. If you've changed APIs, update the documentation.
27
-
4. Ensure the test suite passes.
28
-
5. Make sure your code lints.
29
-
6. Issue that pull request!
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!
30
29
31
30
## Any contributions you make will be under the GNU Affero General Public License v3.0
32
31
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.
33
32
34
33
## Report bugs using [Github Issues](https://github.com/kyb3r/modmail/issues)
35
-
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!
34
+
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!
36
35
37
36
## Write bug reports with detail, background, and sample code
38
37
**Great Bug Reports** tend to have:
39
38
40
-
- A quick summary and/or background
39
+
- A quick summary and background
41
40
- Steps to reproduce
42
41
- Be specific!
43
42
- What you expected would happen
44
-
- What actually happens
43
+
- What *actually* happens
45
44
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
0 commit comments