From 58bf23866f34f909ae7124b7a8c2e906c4f18cab Mon Sep 17 00:00:00 2001 From: Kyle Lobo Date: Tue, 4 Jun 2019 21:22:37 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..445c5a4 --- /dev/null +++ b/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 + - +- 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 fooBar branch. + - Travis CI is watching you! + +If you follow these instructions, your PR will land pretty safely in the main repo!