diff options
| -rw-r--r-- | CONTRIBUTING.md | 30 | ||||
| -rw-r--r-- | PULL_REQUEST_TEMPLATE.md | 11 |
2 files changed, 41 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..dbf9308 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# How to contribute + +First off, thanks for taking the time to contribute! + +## Submitting changes + +Please send a [GitHub Pull Request](https://github.com/Cyclenerd/gallery_shell/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)). + +Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this: + +``` +$ git commit -m "A brief summary of the commit +> +> A paragraph describing what changed and its impact." +``` + +## Coding style + +Start reading the code and you'll get the hang of it. It is optimized for readability: + +* Variables must be uppercase and should begin with `MY_`. +* Functions must be lower case. +* Check your shell scripts with [ShellCheck](https://www.shellcheck.net/) before submitting. +* Please use tabs to indent. + +One more thing: + +* Keep it simple! 👍 + +Thanks! ❤️❤️❤️
\ No newline at end of file diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..f2c9c5a --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +First off, thanks for taking the time to contribute! + +## Please Complete the Following + +- [ ] I read [CONTRIBUTING.md](https://github.com/Cyclenerd/gallery_shell/blob/master/CONTRIBUTING.md) +- [ ] I used tabs to indent +- [ ] I checked my code with [ShellCheck](https://www.shellcheck.net/) + +## Notes + +Feel free to put whatever you want here.
\ No newline at end of file |