NESCent / popgenInfo

Vignettes for Population Genetics in R
http://popgen.nescent.org
MIT License
21 stars 50 forks source link

Update steps in CONTRIBUTING to match steps in CWG2R #153

Closed zkamvar closed 8 years ago

zkamvar commented 8 years ago

I've noticed that CONTRIBUTING has 12 steps for the process of submitting a vignette, most of which are specific to first time setup. Should we pare these steps down to the 4 (or six, if starting) steps that are in Contributing With git2R? This would also bring the steps in alignment with our figure.

Here's what I'm envisioning:


Setup for new contributors

If you are a new contributor, you will need to make sure you have git set up and a fork of this repository. Please follow these instructions carefully. If you have already set up your repository, go to the next section.

  1. Set up a GitHub account if you don't already have one, see here for a quick tutorial on using GitHub.
  2. Download an appropriate Git client for your computer, see here, and set it up.
  3. Fork the source repository on GitHub using the Fork button (See GitHub's tutorial).
  4. On the command line, clone the repository to your machine using
    git clone https://github.com/YourAccount/popgenInfo.git
    Note: the https protocol is easier to follow, but it's possible to use ssh as well (details here).
  5. Add the NESCent repository to upstream with
    git remote add NESCent https://github.com/NESCent/popgenInfo.git
    to keep your fork up to date with the master repository. See these instructions for details

    Step-by-step process for submission

If you have a vignette you would like to submit, please follow these instructions to submit it for review.

  1. Update your fork

    1. From the command line, move to the popgenInfo directory using cd popgenInfo
    2. Switch to your master branch with git checkout master
    3. Update with
    git fetch NESCent          # grab all the changes from NESCent
    git merge NEScent/master   # add them to your local fork
    git push                   # push them up to your fork on github
  2. Create a branch for your changes using git checkout -b Your_branch_name.
  3. Add your vignette
    1. If you are on windows or macintosh, you can open Rstudio by double-clicking on the popgenInfo.Rproj file in your file browser. If you are on linux, you can open it by typing rstudio popgenInfo.Rproj.
    2. If you haven't done so, create your vignette from the TEMPLATE.Rmd file and move any associated data to the data/ directory.
    3. Move your vignette in .Rmd format into the use/ directory.
    4. Add the file to git using git add use/yourfilename.Rmd data/yourdata.txt.
    5. Then commit this using git commit and add some short text describing what your file is.
  4. Push to your fork and create a new pull request
    1. From the command line, run git push --set-upstream origin Your_branch_name to push your branch to your remote fork
    2. To do a pull request, navigate to your branch on GitHub. Click Compare & review or the pull request icon.
    3. Once you have reviewed the changes, click Create pull request. Once the request is approved, the file will be automatically sent to a remote server that compiles the document into a html file.
smanel commented 8 years ago

This new way to order the step seems to be a good idea . In addition aligning the steps with the figure is great!

zkamvar commented 8 years ago

Should I merge #158?

smanel commented 8 years ago

yes.

zkamvar commented 8 years ago

Since this is currently a pull request, I will close this issue and let the conversation go on there.