---
# System prepended metadata

title: Collaborative Document Following Best Practice

---

![](https://i.imgur.com/iywjz8s.png)

# Collaborative Document Following Best Practice

### 2023-05-24 Following best practice, programming style, for STEMMUS-SCOPE

## 👩‍🏫👩‍💻🎓 Instructors

Sarah Alidoost, Bart Schilperoort and Yang Liu

## 👩‍💻👩‍💼👨‍🔬🧑‍🔬🧑‍🚀🧙‍♂️🔧 Participants
(Add your names below)
Yijian Zeng
Zengjing Song
Prajwal Khanal
Enting Tang
Qianqian Han
Danyang Yu
Yunfei Wang

## 🙋Getting help

To ask a question, just raise your hand.

## 🗓️ Agenda
| | |
|-|-|
|10:00 – 10:30| Introduction and collaborative workflow |
|10:30 – 11:00| Demo |
|11:00 – 11:15| Coffee break |
|11:15 - 12:00| Modular code development |
|12:00 – 13:00| Lunch |
|13:00 – 13:30| Code styles and documentation |
|13:30 – 14:15| Exercise – Setup, fix an issue, and submit a pull request |
|14:15 – 14:30| Coffee break |
|14:30 – 15:30| Exercise - Review a pull request and merge |
|15:30 – 15:45| Coffee break |
|15:45 – 16:30| Wrap-up and questions |


## 🔧 Exercises

### 1. Setup, fix an issue and submit a pull request

### 🛠 Check the issues for each group

| | |
|-|-|
|Group|Link to issues|
|Zengjing & Danyang| [Link to issue #163](https://github.com/EcoExtreML/STEMMUS_SCOPE/issues/163) |
|Enting & Prajwal| [Link to issue #164](https://github.com/EcoExtreML/STEMMUS_SCOPE/issues/164) | 
|Qianqian & Yijian & Bob| [Link to issue #165](https://github.com/EcoExtreML/STEMMUS_SCOPE/issues/165) |
|Yang & Yunfei| [Link to issue #166](https://github.com/EcoExtreML/STEMMUS_SCOPE/issues/166) |

### 🖥 Create PR
| | | |
|-|-|-|
|Group| Link to your PR| Reviewer | 
|Zengjing & Danyang| #issue 163 https://github.com/EcoExtreML/STEMMUS_SCOPE/pull/174 | Yang Liu, Enting |
|Enting & Prajwal| Issue 164: https://github.com/EcoExtreML/STEMMUS_SCOPE/pull/176  |Zengjing Song & Yunfei Wang |
|Bas & Yijian & Bob | Issue 165: https://github.com/EcoExtreML/STEMMUS_SCOPE/pull/175| Bart, Sarah| 
|Yang & Yunfei| [Link to PR addresses issue 166](https://github.com/EcoExtreML/STEMMUS_SCOPE/pull/171) | Danyang & Qianqian|

## 🧠 Questions

## Tips (one thing to improve)
Yijian: perfect, very useful session to learn the workflow live. We should try to have such session every three months.


## Tops (one thing you liked)
Yang: Nice to work with everyone.
Yijian: The discussion in between, and going through the whole workflow via pair-programming.
Danyang: The practice is very specifical and useful!


Enting: Very specific examples and exercise!

Zengjing: It's very nice work together.The examples are very helpful to practice.


Qianqian: Well prepared workshop, clear explanation and useful practice.

Yunfei: Very useful and we will benifit in the future programming.

Prajwal: The workshop is very nicely planned with the exercise and the examples. 

## 📚 Resources

- [Slides](https://nlesc.sharepoint.com/:b:/s/team-beta/ERUF7UtMJFxHhMzk-WTPSHwBCtdYBv-c-C3oKZolfFUz9Q?e=0vubVC)
- sample data on CRIB can be found at `/data/shared/EcoExtreML/Tutorial_data_24052023/ZA-Kru_2023-05-23-1449`