From bfbec919c0e10a48b3655a4cde5b5a5640f9ef58 Mon Sep 17 00:00:00 2001 From: Chester Leung Date: Fri, 11 Jun 2021 14:19:16 -0700 Subject: [PATCH] Add contributing guidelines (#140) * Add contributing guidelines --- CONTRIBUTING.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..46d0bb4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,17 @@ +# Contributing to MC2 + +## Reporting bugs and asking questions + +You can ask questions, bring up issues, or garner feedback through the following channels: + +1. [Slack](https://join.slack.com/t/mc2-project/shared_invite/zt-rt3kxyy8-GS4KA0A351Ysv~GKwy8NEQ) +2. [GitHub Issues](https://github.com/mc2-project/mc2/issues) +3. Email: send an email to mc2-dev@googlegroups.com + +## To contribute a patch + +1. Break your work into small, single-purpose patches if possible. It's much + harder to merge in a large change with a lot of disjoint features. +2. Submit the patch as a GitHub pull request against the master branch. +3. Make sure that your code passes the automated tests. +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.