Contribute update #121
Merged
Contribute update #121
Conversation
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
DrLynTaylor
requested changes
Nov 6, 2023
contribution.qmd
Outdated
| @@ -12,16 +12,34 @@ 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) | |||
|
|
|||
| 1. Set up RStudio to clone the CAMIS github repo -- See this [guidance for more detail](https://github.com/PSIAIMS/CAMIS/blob/main/minutes/posts/13Feb2023_Contributing%20to%20the%20CAMIS%20project_Setting%20up%20communication%20between%20github%20and%20R%20studio.docx) | |||
| 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 | |||
There was a problem hiding this comment.
Should this be step 5?
contribution.qmd
Outdated
|
|
||
| 2. If this is your first contribution, contact [christina.e.fillmore\@gsk.com](mailto:christina.e.fillmore@gsk.com) and give her your github username, requesting to access the CAMIS repo for contributions | ||
| 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). |
There was a problem hiding this comment.
update to:
- 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.
For more information Jenny Bryan has a great bookdown explaining how to get setup, alternatively see the following link for a short guidance.
contribution.qmd
Outdated
|
|
||
|  | ||
|
|
||
| 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. |
There was a problem hiding this comment.
working from your own fork,
planning on contributing regularly.
contribution.qmd
Outdated
|
|
||
| 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. |
There was a problem hiding this comment.
Once you have completed the change
contribution.qmd
Outdated
|
|
||
|  | ||
|
|
||
| 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'. |
There was a problem hiding this comment.
you will see that your repo is now
DrLynTaylor
approved these changes
Nov 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.