From 8c5b8d8e74e87768aaf1a18fdbd3426226637cf6 Mon Sep 17 00:00:00 2001 From: gmemstr Date: Fri, 17 Nov 2017 14:09:55 -0800 Subject: [PATCH] Add contributing.md --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e585e85 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,30 @@ +# Contributing + +Generally, any contributions to Pogo are more than welcome, but we'd like it if you follow a couple guidelines. We'll also point out a couple of tricks for ease of use. + +First, fork the repository and clone it locally + + +``` +git clone git@github.com:your-username/pogo.git +``` + +Set up Go and install the dependencies + +``` +cd pogo +go get github.com/tools/godep +godep restore +``` + +Then make your changes. If you use Sublime Text 3, please check out [our snippets](https://gist.github.com/gmemstr/60831109f0ae6c40861c1751a367524e) to add some shortcuts to make your life easier. + +The platform is divided into two main parts: The main Go app, which does everything from generating RSS to serving up webpages, and the Vue.js app portion, which currently handles the admin interface but will be implemented into the main frontend as well. + +Once you've made your changes, please make sure the app can build + +``` +go build +``` + +Once you've verified your addition works, push to your repository and [create a pull request](https://github.com/gmemstr/pogo/compare). During the review your PR will also pass through our TravisCI testing as well. \ No newline at end of file