Closed zkamvar closed 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!
Should I merge #158?
yes.
Since this is currently a pull request, I will close this issue and let the conversation go on there.
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.
Fork
button (See GitHub's tutorial).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).
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.
Update your fork
cd popgenInfo
git checkout master
git checkout -b Your_branch_name
.rstudio popgenInfo.Rproj
.TEMPLATE.Rmd
file and move any associated data to the data/ directory..Rmd
format into the use/ directory.git add use/yourfilename.Rmd data/yourdata.txt
.git commit
and add some short text describing what your file is.git push --set-upstream origin Your_branch_name
to push your branch to your remote forkCompare & review
or the pull request icon.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.