Skip to content

Commit bfbec91

Browse files
Add contributing guidelines (#140)
* Add contributing guidelines
1 parent 8817d88 commit bfbec91

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

CONTRIBUTING.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Contributing to MC<sup>2</sup>
2+
3+
## Reporting bugs and asking questions
4+
5+
You can ask questions, bring up issues, or garner feedback through the following channels:
6+
7+
1. [Slack](https://join.slack.com/t/mc2-project/shared_invite/zt-rt3kxyy8-GS4KA0A351Ysv~GKwy8NEQ)
8+
2. [GitHub Issues](https://github.com/mc2-project/mc2/issues)
9+
3. Email: send an email to [email protected]
10+
11+
## To contribute a patch
12+
13+
1. Break your work into small, single-purpose patches if possible. It's much
14+
harder to merge in a large change with a lot of disjoint features.
15+
2. Submit the patch as a GitHub pull request against the master branch.
16+
3. Make sure that your code passes the automated tests.
17+
4. Make sure that your code passes the linter. Run `pip3 install pre-commit; pre-commit install` to create a git hook that will run the linter before you push your changes.

0 commit comments

Comments
 (0)