git.iko.soy/typeable/oauth2-proxy
on master help sign in
Add CONTRIBUTING guide
commit3253bef85411eead2aa3cbd4d6a3e1cfca00d0da authorJoel Speed <Joel.speed@hotmail.co.uk> dateThu 20 Dec 2018, 14:14 (8 years ago) parent8564ab6
3 files changed+27
CHANGELOG.md+1 CONTRIBUTING.md+22 README.md+4
CHANGELOG.md+1
@@ -2,6 +2,7 @@
22
33## Changes since v2.2:
44
5+- Add CONTRIBUTING guide
56- Add Issue and Pull Request templates
67- Add Dockerfile
78- Fix fsnotify import
CONTRIBUTING.mdnew file+22
@@ -0,0 +1,22 @@
1+# Contributing
2+
3+To develop on this project, please fork the repo and clone into your `$GOPATH`.
4+
5+Dependencies are **not** checked in so please download those separately.
6+Download the dependencies using [`dep`](https://github.com/golang/dep).
7+
8+```bash
9+cd $GOPATH/src/github.com # Create this directory if it doesn't exist
10+git clone git@github.com:<YOUR_FORK>/oauth2_proxy pusher/oauth2_proxy
11+dep ensure # Installs dependencies to vendor folder.
12+```
13+
14+## Pull Requests and Issues
15+
16+We track bugs and issues using Github.
17+
18+If you find a bug, please open an Issue.
19+
20+If you want to fix a bug, please fork, create a feature branch, fix the bug and
21+open a PR back to this repo.
22+Please mention the open bug issue number within your PR if applicable.
README.md+4
@@ -420,3 +420,7 @@ server {
420420 }
421421}
422422```
423+
424+## Contributing
425+
426+Please see our [Contributing](CONTRIBUTING.md) guidelines.