You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+49-9Lines changed: 49 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ If you are interested in joining, please go [here](https://advance.hub.phuse.glo
9
9
Take a look to the [website](https://phuse-org.github.io/git-in-statistical-programming/) (made with Quarto).
10
10
11
11
12
-
# Objectives and Deliverables
12
+
## 1. Objectives and Deliverables
13
13
14
14
1. Principles for using Git and example workflow(s) in context of the current QC process
15
15
@@ -27,9 +27,45 @@ Take a look to the [website](https://phuse-org.github.io/git-in-statistical-prog
27
27
3. Core education on Git for statistical programmers
28
28
4. Soft proposal for an alternative QC process using Git features
29
29
30
-
#R use
30
+
## 2. How to Contribute
31
31
32
-
This repository will be using quarto. To support this, there is an renv lock file which is currently bare bones.
32
+
You can get involved in one of the following ways
33
+
34
+
2.1 - If you wish to join the working group please [go here](https://advance.hub.phuse.global/wiki/spaces/WEL/pages/90472449/The+Use+of+Git+in+Statistical+Programming) for the leads to reach out to them
35
+
2.2 - You can get involved in discussion via the issues
36
+
2.3 - You can propose a merge request via a fork if you see something that needs fixing
37
+
38
+
39
+
### 2.3. Using Git, to propose changes!
40
+
41
+
#### 2.3.1 About cloning, branching and pushing
42
+
43
+
Basic steps to get into this "Git world"
44
+
45
+
0- Ensure you have installed Git, and you use the terminal to go to your favorite directory.
46
+
47
+
1- Clone the repo from your terminal `git clone https://github.com/phuse-org/git-in-statistical-programming.git`
48
+
49
+
2- Create a branch with your username `git checkout -b yourname_dev` All the changes and contributions will be done here
50
+
51
+
3- once this is done, add changes to stage `git add .`
52
+
53
+
4- once this is done, commit the changes with a message `git commit -m " i did this change (your summary of the changes)"
54
+
55
+
5- finally push the changes! `git push origin yourname_dev`
56
+
57
+
6- if you go now to the repo https://github.com/phuse-org/git-in-statistical-programming.git you will see at the top a message saying your changes has been pushed into your named branch.
58
+
59
+
7- if you want your changes being in the "main" branch (default page), you have to create a merge request. (green button top right saying "compare & pull request")
60
+
61
+
62
+
63
+
💡NOTE: If you like to use your Chat GPT to teach you more about these steps, use it. No fear to break anything!
64
+
💡NOTE2: There is a wonderful tutorial in [Coursera] (https://www.coursera.org/learn/making-data-science-work-for-clinical-reporting#modules) to practise on your own how to do these steps. Very easy and well explained (and you get a certification 🎓 at the end!)
65
+
66
+
#### 2.3.2 About R
67
+
68
+
This repository will be using quarto. To support this repository, there is an **renv lock** file which is currently bare bones.
33
69
(This means we can keep traceability of the R packages we are using within this repo)
34
70
35
71
```R
@@ -38,13 +74,17 @@ renv::restore() # to install packages required
38
74
39
75
# if you made changes to the environment (installing new packages) you can save them by:
40
76
renv::snapshot()
41
-
```
42
77
43
-
# How to Contribute
78
+
```
44
79
45
-
You can get involved in one of the following ways
80
+
For the poster it would be nice to have some stats in a jupyter or Rmarkdown about issues around Git (or some charts explaining key points).
81
+
To start with,
82
+
0 - clone the repo in your laptop
83
+
1 - create your own git branch:
84
+
```sh
85
+
# in terminal, within your project directory
86
+
git checkout -b yourname_dev
87
+
```
88
+
2- A folder called **"script_ideas"** will be the SANDBOX with your scripts/ collaborative scripts/pictures to get some charts/numbers around this topic (for the paper or poster, or to discuss in our meetings).
46
89
47
-
- If you wish to join the working group please [go here](https://advance.hub.phuse.global/wiki/spaces/WEL/pages/90472449/The+Use+of+Git+in+Statistical+Programming) for the leads to reach out to them
48
-
- You can get involved in discussion via the issues
49
-
- You can propose a merge request via a fork if you see something that needs fixing
0 commit comments