Skip to content

Commit

Permalink
Fix spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
statasaurus committed Nov 7, 2023
1 parent 8a60074 commit 1621be1
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions contribution.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ Please contribute by submitting a pull request to and our team will review it. I

**Instructions for Contributions to** [**the CAMIS repository**](https://github.com/PSIAIMS/CAMIS)

The following instructions assume you have not done a contribution in the past. If you have contributed in the past skip down to step 000000
The following instructions assume you have not done a contribution in the past. If you have contributed in the past skip down to step 5

1. You will need to git, github, and RStudio setup to talk to each other. To do this you will need to have a github account and git installed on your computer. And then connect your computer to github, we tend to recommend using a PAT because it is bit easier than SSH. We have a script that can help you set that up, found [here](https://github.com/PSIAIMS/git-training/blob/3abcc07a37aa50be161392a0327007b92cf35f9c/git-cred.R). For more information Jenny Bryan has a great [bookdown](https://happygitwithr.com) explaining how to get setup, alternative we have a [short guidance](https://github.com/PSIAIMS/CAMIS/blob/main/minutes/posts/13Feb2023_Contributing%20to%20the%20CAMIS%20project_Setting%20up%20communication%20between%20github%20and%20R%20studio.docx).
1. You will need to get git, github, and RStudio setup to talk to each other. To do this you will need to have a github account and git installed on your computer. To connect your computer to github, we tend to recommend using a PAT because it is bit easier than SSH. We have a script that can help you set that up, found [here](https://github.com/PSIAIMS/git-training/blob/3abcc07a37aa50be161392a0327007b92cf35f9c/git-cred.R).
For more information Jenny Bryan has a great [bookdown](https://happygitwithr.com) explaining how to get setup, alternatively see the following link for a [short guidance](https://github.com/PSIAIMS/CAMIS/blob/main/minutes/posts/13Feb2023_Contributing%20to%20the%20CAMIS%20project_Setting%20up%20communication%20between%20github%20and%20R%20studio.docx).

2. Now with RStudio all setup, you will need to "fork" the repository, which basically mean you want to make a copy of this repository that you own, so it will be under your github profile. This will allow you to make changes, without needing direct permission. To do this you will need to go into github, into the CAMIS repo, and click "fork". This will give you some options of how you want to fork the repo, honestly you can just keep the defaults and then click "Create fork"

Expand All @@ -28,15 +29,15 @@ The following instructions assume you have not done a contribution in the past.

![](images/contributions/clone2.png)

5. Go into RStudio and Create a branch -- Give you are working from you own fork, this step it is a bit optional. It is up to you if you want to make a separate branch or not. But, it is generally considered good practice, especially if you are planning on contribute regularly. To do this from RStudio click the branch button (on the git tab top right). Within the box that comes up ensure you are on the "remote=origin" and "Sync branch with remote" is checked. You can name the branch something to do with the amends you intend to make.
5. Go into RStudio and Create a branch -- Give you are working from your own fork, this step it is a bit optional. It is up to you if you want to make a separate branch or not. But, it is generally considered good practice, especially if you are planning on contributing regularly. To do this from RStudio click the branch button (on the git tab top right). Within the box that comes up ensure you are on the "remote=origin" and "Sync branch with remote" is checked. You can name the branch something to do with the amends you intend to make.

6. Edit and /or add files within the CAMIS directories. If you are adding SAS guidance store under sas folder, R guidance store under r folder, for "SAS vs R" comparison store under comp. Follow the naming convention of the files already stored in those folders.

7. Within R studio - Commit each change or new file added, and push to the repo from within R studio. Once you have complete the change you want to make, it is time for a pull request. Before we start though, it is good to check that your branch on github contains all the update you have done. If not you may need to push from Rstudio before moving onto the pull request.
7. Within R studio - Commit each change or new file added, and push to the repo from within R studio. Once you have completed the change you want to make, it is time for a pull request. Before we start though, it is good to check that your branch on github contains all the update you have done. If not you may need to push from Rstudio before moving onto the pull request.

![This is what it will look like if you still need to push](images/contributions/push.png)

8. Pull request in github - Back on your fork in github you will see that you repo is now ahead of the main CAMIS repository. The first thing you want to do is make sure there aren't any conflict that have arisen with the main repository, so you need to click 'Sync fork'.
8. Pull request in github - Back on your fork in github you will see that your repo is now ahead of the main CAMIS repository. The first thing you want to do is make sure there aren't any conflict that have arisen with the main repository, so you need to click 'Sync fork'.

![](images/contributions/make-pr.png)

Expand Down

0 comments on commit 1621be1

Please sign in to comment.