Skip to content

Commit 0431496

Browse files
Merge pull request #14 from phuse-org/croca_dev
updated readme to make it simple
2 parents 43f4c01 + e463719 commit 0431496

File tree

1 file changed

+25
-4
lines changed

1 file changed

+25
-4
lines changed

README.md

+25-4
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,18 @@ Take a look to the [website](https://phuse-org.github.io/git-in-statistical-prog
3232
You can get involved in one of the following ways
3333

3434
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+
3536
2.2 - You can get involved in discussion via the issues
37+
3638
2.3 - You can propose a merge request via a fork if you see something that needs fixing
3739

3840

3941
### 2.3. Using Git, to propose changes!
4042

41-
#### 2.3.1 About cloning, branching and pushing
43+
44+
<details>
45+
46+
<summary>2.3.1 About cloning, branching and pushing</summary>
4247

4348
Basic steps to get into this "Git world"
4449

@@ -63,7 +68,14 @@ Basic steps to get into this "Git world"
6368
💡NOTE: If you like to use your Chat GPT to teach you more about these steps, use it. No fear to break anything!
6469
💡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!)
6570

66-
#### 2.3.2 About R
71+
</details>
72+
73+
74+
75+
<details>
76+
77+
<summary>2.3.2 About R</summary>
78+
6779

6880
This repository will be using quarto. To support this repository, there is an **renv lock** file which is currently bare bones.
6981
(This means we can keep traceability of the R packages we are using within this repo)
@@ -79,12 +91,21 @@ renv::snapshot()
7991

8092
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).
8193
To start with,
82-
0 - clone the repo in your laptop
83-
1 - create your own git branch:
94+
95+
0 - after you have clones the repo in your laptop
96+
97+
1 - you are in your branch
98+
8499
```sh
85100
# in terminal, within your project directory
101+
#create your own git branch:
86102
git checkout -b yourname_dev
103+
# or switch to your branch
104+
git switch yourname_dev
87105
```
106+
88107
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).
89108

109+
</details>
110+
90111

0 commit comments

Comments
 (0)