Create CONTRIBUTING.md

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing Guide
+
+Contributing to `project_name` is fairly easy. This document shows you how to get started.
+
+## Contributing / Submitting changes
+
+- Fork the repo
+  - <https://github.com/kylelobo/The-Documentation-Compendium/fork>
+- Check out a new branch based and name it to what you intend to do:
+  - Example:
+    ````
+    $ git checkout -b BRANCH_NAME feature/fooBar
+    ````
+    If you get an error, you may need to fetch fooBar first by using
+    ````
+    $ git remote update && git fetch
+    ````
+  - Use one branch per fix / feature
+- Commit your changes
+  - Please provide a git message that explains what you've done.
+  - Please make sure your commits follow the [conventions](https://gist.github.com/robertpainsi/b632364184e70900af4ab688decf6f53#file-commit-message-guidelines-md)
+  - Commit to the forked repository.
+  - Example:
+    ````
+    $ git commit -am 'Add some fooBar'
+    ````
+- Push to the branch
+  - Example:
+    ````
+    $ git push origin feature/fooBar
+    ````
+- Make a pull request
+  - Make sure you send the PR to the <code>fooBar</code> branch.
+  - Travis CI is watching you!
+
+If you follow these instructions, your PR will land pretty safely in the main repo!