From 3253bef85411eead2aa3cbd4d6a3e1cfca00d0da Mon Sep 17 00:00:00 2001 From: Joel Speed Date: Thu, 20 Dec 2018 14:14:04 +0000 Subject: [PATCH] Add CONTRIBUTING guide --- CHANGELOG.md | 1 + CONTRIBUTING.md | 22 ++++++++++++++++++++++ README.md | 4 ++++ 3 files changed, 27 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 6afed7c..2684e0a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ ## Changes since v2.2: +- Add CONTRIBUTING guide - Add Issue and Pull Request templates - Add Dockerfile - Fix fsnotify import diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f92d18c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +To develop on this project, please fork the repo and clone into your `$GOPATH`. + +Dependencies are **not** checked in so please download those separately. +Download the dependencies using [`dep`](https://github.com/golang/dep). + +```bash +cd $GOPATH/src/github.com # Create this directory if it doesn't exist +git clone git@github.com:/oauth2_proxy pusher/oauth2_proxy +dep ensure # Installs dependencies to vendor folder. +``` + +## Pull Requests and Issues + +We track bugs and issues using Github. + +If you find a bug, please open an Issue. + +If you want to fix a bug, please fork, create a feature branch, fix the bug and +open a PR back to this repo. +Please mention the open bug issue number within your PR if applicable. diff --git a/README.md b/README.md index c05dceb..4fc429d 100644 --- a/README.md +++ b/README.md @@ -420,3 +420,7 @@ server { } } ``` + +## Contributing + +Please see our [Contributing](CONTRIBUTING.md) guidelines.