Skip to content

Commit 92582a3

Browse files
authored
Merge pull request #5 from ARCTraining/collaboraiton
Add in content for collaboration
2 parents b374719 + 98a1a62 commit 92582a3

File tree

7 files changed

+160
-15
lines changed

7 files changed

+160
-15
lines changed

_quarto.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ website:
1212
logo-alt: "Logo, with a cartoon blue cloud with electronic circuits"
1313
sidebar:
1414
contents:
15+
- href: https://github.com/ARCTraining/git
16+
text: Visit the GitHub repository
1517
- section: Day 1
1618
contents:
1719
- href: version_control/01_intro.qmd
@@ -26,7 +28,8 @@ website:
2628
contents:
2729
- href: version_control/05_undo_changes.qmd
2830
- href: version_control/05_homework.qmd
29-
- href: version_control/collaboration.qmd
31+
- href: version_control/06_collaboration.qmd
32+
- href: version_control/06_practical.qmd
3033

3134
format:
3235
html:

assets/collab1.png

112 KB
Loading

assets/collab2.png

136 KB
Loading
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "6. Collaboration"
3+
subtitle: "How do we work together with others on projects?"
4+
format:
5+
html:
6+
respect-user-color-scheme: true
7+
theme:
8+
light: [cosmo, ../theme.scss, styles.scss]
9+
dark: [cosmo, ../theme-dark.scss, styles.scss]
10+
css: ../styles.css
11+
toc: true
12+
---
13+
14+
Let's learn about some git features that can help with collaboration!
15+
16+
:::{.callout-tip}
17+
## Reveal.js Presentation Controls
18+
19+
The presentation linked below uses Reveal.js to build a HTML presentation. You can use the following keyboard shortcuts:
20+
21+
- **Navigate slides**: Use arrow keys (←/→) or space bar to advance
22+
- **Overview mode**: Press `O` to see all slides at once
23+
- **Speaker notes**: Press `S` to open speaker view
24+
- **Help menu**: Press `?` to see all keyboard shortcuts
25+
- **Fullscreen**: Press `F` to toggle fullscreen mode
26+
- **Zoom**: Press `Alt` + click to zoom in on slide content
27+
- **Print/PDF**: Add `?print-pdf` to the URL for print-friendly version
28+
29+
:::
30+
31+
[Open introduction presentation ↗](06_presentation.qmd){.btn .btn-outline-primary .btn role="button" data-toggle="tooltip" title="Open presentation in a new tab" target="_blank"}

version_control/06_practical.qmd

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "6.1 Practical"
3+
subtitle: "Forking repositories and collaborating"
4+
5+
---
6+
7+
In this practical, we're going to *fork* and collaborate on a repository together!
8+
9+
1. Fork this [repository](https://github.com/ARCTraining/git-oct-2025), accept the defaults.
10+
2. You'll see a spooky halloween story in the README.md file (copied below).
11+
- Let's start contributing to the story!
12+
- Make changes in your fork and contribute back to the main.
13+
14+
15+
16+
## 🎃 The Haunted Lab Mad Libs 🧪
17+
18+
**Fill in the blanks and discover what happens when science meets the supernatural!**
19+
20+
It was a **[adjective]** October night when Dr. **[last name]** was working late in their **[adjective]** laboratory. They had been studying **[plural noun]** for **[number]** months, hoping to make a **[adjective]** breakthrough.
21+
22+
As they **[past tense verb]** through their research notes, something **[adjective]** caught their eye. A petri dish containing **[gross substance]** was **[verb ending in -ing]** three feet above the lab bench!
23+
24+
"This is **[exclamation]**!" they whispered, adjusting their **[plural noun]** nervously. The dish began to **[verb]** in a **[adjective]** pattern, glowing with a **[color]** light.
25+
26+
Suddenly, a **[adjective]** voice echoed through the lab: "Your research on **[scientific term]** has awakened us! We are the spirits of **[number]** researchers who died from **[silly cause of death]**!"
27+
28+
Dr. **[same last name]** grabbed their **[lab equipment]** and **[past tense verb]** toward the exit, but the ghostly petri dish **[past tense verb]** them, leaving behind only the smell of **[weird smell]** and a mysterious **[color]** residue.
29+
30+
*The next morning, their lab mates found only a **[adjective]** note that read: "Gone to study **[spooky subject]** with the ghost researchers. Back by **[day of week]**... maybe."*
31+
32+
**🧬 Happy Halloween from the haunted lab! 👻**
Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
---
2+
title: "Collaboration"
3+
subtitle: "Tools that can help with collaborating on git repositories"
4+
# bibliography: ../assets/refs.bib
5+
format:
6+
revealjs:
7+
theme: styles.scss
8+
footer: "[SWD2: Intro to version control with git and GitHub](../index.qmd) | [Advanced Research Computing, Uni of Leeds](https://arc.leeds.ac.uk/) | [Ask us for help](https://it.leeds.ac.uk/it?id=sc_cat_item&sys_id=7587b2530f675f00a82247ece1050eda)"
9+
---
10+
11+
## There are many ways to collaborate
12+
13+
![Everyone can use one repository, added as collaborators](../assets/collab1.png)
14+
15+
## There are many ways to collaborate
16+
17+
:::: {.columns}
18+
19+
::: {.column width="60%"}
20+
21+
![Everyone can use one repository, added as collaborators](../assets/collab1.png)
22+
23+
:::
24+
25+
::: {.column width="40%"}
26+
27+
- You need to trust everyone!
28+
- Important to use branches
29+
- Good for small teams
30+
31+
:::
32+
33+
::::
34+
35+
## There are many ways to collaborate
36+
37+
![People can fork or copy the repository](../assets/collab2.png)
38+
39+
## There are many ways to collaborate
40+
41+
:::: {.columns}
42+
43+
::: {.column width="50%"}
44+
45+
![People can fork or copy the repository](../assets/collab2.png)
46+
47+
:::
48+
49+
::: {.column width="50%"}
50+
51+
- Can let anyone fork the repository and make changes
52+
- They have to make a "pull request" so you can review their changes
53+
- Easier for bigger projects
54+
- This is what we will be trying out today!
55+
56+
:::
57+
58+
::::
59+
60+
## Useful git tools: `.gitignore`
61+
62+
- Something that is particularly useful when working on a group project is the git ignore file
63+
64+
:::: {.columns}
65+
66+
::: {.column width="50%"}
67+
68+
- A file called `.gitignore` in the top/parent directory of your git repository
69+
- Plain text file with a list of files that should not be tracked with git
70+
71+
:::
72+
73+
::: {.column width="50%"}
74+
75+
```text
76+
77+
scratch_notes.md
78+
__pycache__/
79+
.ipynb_checkpoints
80+
_build/
81+
*.egg
82+
83+
```
84+
85+
*We can chat about Jupyter notebooks and their issues with git at the end of the course during the Q&A if you like.*
86+
87+
:::
88+
89+
::::
90+
91+
## Collaboration
92+
93+
Let's jump straight in to it!

version_control/collaboration.qmd

Lines changed: 0 additions & 14 deletions
This file was deleted.

0 commit comments

Comments
 (0)