aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorTrey <32907415+TheEdgeNK@users.noreply.github.com>2018-03-31 18:43:21 -0400
committerGitHub <noreply@github.com>2018-03-31 18:43:21 -0400
commitd2e555d026cdbf7caba383776173a7dc746210dc (patch)
tree0d281572f9c70d6821907c3df85ac5b9335d77d2 /CONTRIBUTING.md
parentf14a32689705f5c35e0ba990c3e7773821b7d929 (diff)
downloadPokeBot-d2e555d026cdbf7caba383776173a7dc746210dc.tar.gz
PokeBot-d2e555d026cdbf7caba383776173a7dc746210dc.tar.bz2
PokeBot-d2e555d026cdbf7caba383776173a7dc746210dc.zip
new contributing guide
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..0489ecb
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,12 @@
+# Contributing to PokeBot:
+There are many ways to contribute to PokeBot. Here are the ones we are accepting:
+## Suggestions and Bug Reports
+GitHub's Issue system is great for this, which is why we use it. Submitting a bug report? Tag it with bug? Something else? Find a related tag. You can even style the posts with markdown. How neat.
+## Code Contribution
+If you would rather add code to the project, you can do that as well! Since we are open-source, you can always submit a pull request!
+For pull request criteria, look below:
+* Make sure to learn how to use our custom command handler first before submitting a code contribution.
+* If you are fixing a bug, state what bug you are fixing in the pull request.
+* Do not write messy code. This is Trey's job and Justin cleans up after him enough. We don't want to raise his salary.
+
+That's it! We hope you enjoy contributing to our project!