From 58b64b4d527cac7be77d2fdb1b98922aed489238 Mon Sep 17 00:00:00 2001
From: Nathalie Vialaneix <nathalie.vialaneix@inra.fr>
Date: Tue, 29 Oct 2019 16:07:02 +0100
Subject: [PATCH] started to answer issue #34

---
 .github/CONTRIBUTING.md   | 26 ++++++++++++++++++++++++++
 .github/blogdown_usage.md | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 .github/CONTRIBUTING.md
 create mode 100644 .github/blogdown_usage.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..23170a5
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,26 @@
+# CONTRIBUTING #
+
+### Please contribute!
+
+We love collaboration.
+
+### Bugs?
+
+* Submit (or solve!) an issue on the [Issues page](https://github.com/R-miss-tastic/website/issues)
+
+### Contributions to website improvements
+
+* 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/<yourgithubusername>/website.git`
+* Make sure to track progress upstream (i.e., on our version of `website` at `R-miss-tastic/website`) by doing `git remote add upstream https://github.com/R-miss-tastic/website.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 feature branch)
+* Rebuild site entirely using **R** package `blogdown` (with the line code `build_site()`). Be sure to have hugo, R and blogdown installed! More details at
+[this link](https://github.com/R-miss-tastic/website/blob/master/.github/blogdown_usage.md)
+* Commit and push up to your account
+* Submit a pull request to home base (likely master branch, but check to make sure) at `R-miss-tastic/website`
+
+### Prefer to Email?
+
+I will be able to better help you if you post an issue but otherwise, you can send us an email at rmisstastic[AT]clementine.wf.
+
+### Thanks for contributing!
diff --git a/.github/blogdown_usage.md b/.github/blogdown_usage.md
new file mode 100644
index 0000000..b957914
--- /dev/null
+++ b/.github/blogdown_usage.md
@@ -0,0 +1,32 @@
+# Our website is powered using hugo through the **R** package blogdown #
+
+## Where to start?
+
+1. Install <a href="https://gohugo.io/">hugo</a>
+
+2. Install <a href="http://r-project.org/">R</a> and you will also find useful 
+to install <a href="https://rstudio.com/products/rstudio/">RStudio desktop</a>
+
+3. Install the **R** package `blogdown`. Additional **R** packages are also
+needed for this website: `RefManageR` (to manage the bibliography with a simple
+bibtex file) as well as the packages listed in the first chunk of [this file](https://github.com/R-miss-tastic/website/blob/master/content/rpkg.Rmd)
+
+4. The site is built (*i.e.* generated in the directory `public`) running the
+**R** command line `blogdown::build_site()` from the root
+
+## How to add a reference?
+
+Simply edit the file `resources/rmisstastic_biblio.bib` from your local copy of
+the website, rebuild the site as explained above and then push on your github
+fork and make a pull request as explained [here](https://github.com/R-miss-tastic/website/blob/master/.github/CONTRIBUTING.md)
+
+## How to modify a webpage?
+
+Most webpages in the website are md or Rmd files in the directory `content/`. 
+Edit them, rebuild the site as explained above and then push on your github
+fork and make a pull request as explained [here](https://github.com/R-miss-tastic/website/blob/master/.github/CONTRIBUTING.md)
+
+
+
+
+