From 09bfac4e13b67bdebdab4289e97c078bd8103368 Mon Sep 17 00:00:00 2001 From: Scott Chamberlain Date: Wed, 27 Jul 2016 18:43:54 -0600 Subject: [PATCH] added contributing file, fix #18 --- .Rbuildignore | 2 +- CONTRIBUTING.md | 22 ++++++++++++++++++++++ 2 files changed, 23 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md diff --git a/.Rbuildignore b/.Rbuildignore index e81defa..da58dfe 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -5,4 +5,4 @@ README.Rmd .travis.yml ^NEWS\.md$ ^Makefile$ - +^CONTRIBUTING\.md$ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d87128b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# CONTRIBUTING # + +### Please contribute! + +We love collaboration. + +### Bugs? + +* Submit an issue on the Issues page [here](https://github.com/ropenscilabs/getlandsat/issues) + +### Code contributions + +* Fork this repo to your Github account +* Clone your version on your account down to your machine from your account, e.g,. `git clone https://github.com//getlandsat.git` +* Make sure to track progress upstream (i.e., on our version of `getlandsat` at `ropenscilabs/getlandsat`) by doing `git remote add upstream https://github.com/ropenscilabs/getlandsat.git`. Before making changes make sure to pull changes in from upstream by doing either `git fetch upstream` then merge later or `git pull upstream` to fetch and merge in one step +* Make your changes (bonus points for making changes on a new branch) +* Push up to your account +* Submit a pull request to home base at `ropenscilabs/getlandsat` + +### Questions? Get in touch: [scott@ropensci.org](mailto:scott@ropensci.org) + +### Thanks for contributing!