-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Nathalie Vialaneix
committed
Oct 29, 2019
1 parent
3430882
commit 58b64b4
Showing
2 changed files
with
58 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) | ||
|
||
|
||
|
||
|
||
|