Skip to content

Commit 45c42a0

Browse files
WeirdllamasTaaku18
authored andcommitted
Update CONTRIBUTING.md (#360)
* Update CONTRIBUTING.md Fixed the bit about Git Flow Fixed the license name and link Just some general stuff
1 parent 3a468a2 commit 45c42a0

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,25 @@ If you are proposing new features, please discuss them with us in the [developme
1313
## We Develop with Github
1414
We use github to host code, to track issues and feature requests, as well as accept pull requests.
1515

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:
16+
## We Use [Git Flow](https://atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)
17+
![Simple Image Of A Git Flow Workflow](https://nvie.com/img/[email protected])
18+
When contributing to this project please make sure you follow this and name your branches appropriately!
1819

19-
1. Fork the repo and create your branch from `master`.
20+
## All Code Changes Happen Through Pull Requests
21+
Make sure you know how Git Flow works before contributing!
22+
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
23+
24+
1. Fork the repo and create your branch from `master` or `development` according to Git Flow.
2025
2. If you've added code that should be tested, add tests.
2126
3. If you've changed APIs, update the documentation.
2227
4. Ensure the test suite passes.
2328
5. Make sure your code lints.
2429
6. Issue that pull request!
2530

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.
31+
## Any contributions you make will be under the GNU Affero General Public License v3.0
32+
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.
2833

29-
## Report bugs using Github's [issues](https://github.com/kyb3r/modmail/issues)
34+
## Report bugs using [Github Issues](https://github.com/kyb3r/modmail/issues)
3035
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!
3136

3237
## Write bug reports with detail, background, and sample code

0 commit comments

Comments
 (0)