From fa9f6147059898bd34c27e96d641a9b985865946 Mon Sep 17 00:00:00 2001 From: Scott J Roberts Date: Sat, 2 Apr 2016 13:30:31 -0400 Subject: [PATCH] updated contributing to add commit hook, github flow, and coc information --- CONTRIBUTING | 3 --- CONTRIBUTING.md | 15 +++++++++++++++ 2 files changed, 15 insertions(+), 3 deletions(-) delete mode 100644 CONTRIBUTING create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING b/CONTRIBUTING deleted file mode 100644 index 2b6d9d7..0000000 --- a/CONTRIBUTING +++ /dev/null @@ -1,3 +0,0 @@ -# Contributing - -I mean... if you want to that'd be great. Very work in progress. Pull requests are welcome. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..361b750 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +# Contributing + +I mean... if you want to that would be great. Very work in progress. Pull requests are welcome. + +## Pull Request Flow + +This project subscribes to the typical [GitHub Flow](https://guides.github.com/introduction/flow/) of branch, commit, pull request, commit, merge. + +## Pre-Commit Hooks + +To keep code consistent and awesome (and avoid common mistakes) this project makes use of a [golang centric pre-commit hook](https://github.com/dnephin/pre-commit-golang). Install pre-commit from [pre-commit.com](http://pre-commit.com/) and install the hook with `pre-commit install`. Commit as usual and the amazingness just happens by default, ensuring commands like go-fmt and go-lint run on every commit. + +## Code of Conduct + +This does not need to be a whole thing but just be nice to each other. Toxic folks are not worth putting up with for a few lines of code. This is solely at my discretion.