Skip to content

Commit

Permalink
Merge pull request #18 from manuGil/exercises/lesson4
Browse files Browse the repository at this point in the history
add exercies of lesson 4
  • Loading branch information
manuGil authored Oct 10, 2024
2 parents f2bd518 + 28c089f commit 654a550
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 8 deletions.
4 changes: 4 additions & 0 deletions gitcodev/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ parts:
- file: exercises/L3-ex04
- file: exercises/L3-ex05
- file: exercises/L4-ex01
- file: exercises/L4-ex02
- file: exercises/L4-ex03
- file: exercises/L4-ex04




Expand Down
1 change: 1 addition & 0 deletions gitcodev/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@

10 changes: 3 additions & 7 deletions gitcodev/exercises/L4-ex01.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@

# Lesson 4 Recapitulation --- Implement a Collaborative workflow
# Lesson 4 Recapitulation --- Implementing a Collaborative Workflow
**Time: 15 min**

Working in teams, define and implement a workflow of your choice (branching/forking) to collaborate in a repository. Names between `[]` indicate who in the team should engage in each activity.

1. [**Administrator**] create a repository for the team using the template: https://github.com/the-magnificents/collab-review
1. [**Administrator**] create a repository for the team using the template: https://github.com/WorkshopGitcodev/collab-review
2. [**Team**] discuss and agree on which workflow to implement for this exercise.
3. [**Team**] each member choses one task from the `faircode-checklist.md` and make changes.
4. [**Team**] each member opens a pull request to the `main` branch with the their changes **Important: do not merge.**
4. [**Team**] each member opens a pull request to the `main` branch with the their changes **Important: Do not merge.**
5. [**Team**] each member makes some other changes to the repository, commits and push.
6. [**Team**] go back to your pull request and see how the latest changes affected your pull request. **Do not merge.**

```{attention}
The collab-review repo is missing. This seems to be a fork of it. But the faircode-checklist.md is not there. https://github.com/xaurado/super_software
```
13 changes: 13 additions & 0 deletions gitcodev/exercises/L4-ex02.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

# Lesson 4 Episode 1 --- Code Reviews
**Time: 15 min**


Working in teams. Practice reviewing code in pull requests created in the last exercise on GitHub. Names between `[]` indicate who in the team should engage in each activity.

1. [Author] Assign one or two team members as reviewers in your pull request (PR).
1. [Reviewer] Reviews, discuss, and suggest changes the pull request(s) following recommendation mentioned so far.
1. [Author] Make changes to PR based on the reviewer(s) suggestions, and updates the PR.
1. [Reviewer] Approves the PR.
1. [Author] Merges the PR into the repository.

8 changes: 8 additions & 0 deletions gitcodev/exercises/L4-ex03.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@

# Lesson 4 Episode 2 --- Guidelines for Contributions
**Time: 10 min**


Working individually. Add **contributing guidelines** to the very repository used in Lessons 1 and 2. Use the template in: https://github.com/manuGil/fair-code to create your own guidelines.


12 changes: 12 additions & 0 deletions gitcodev/exercises/L4-ex04.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@

# Lesson 4 Episode 2 --- Choosing Licenses and Enabling Software Citation
**Time: 10 min**


Working individually. Add a license and citation file to the repository used in Lesson 1 and 2 (workshop?).
1. Add an opensource license to the remote repository. Use the Creative Common license tool to decide which license to use: https://chooser-beta.creativecommons.org
- Check the [GitHub documentation](https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository) to know how to add a license file.
2. Use this tool to generate a CITATION file and add it to your remote repository:
- Search the Internet for: `cffinit`


27 changes: 26 additions & 1 deletion gitcodev/lesson4.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This contains general information about the lesson and illustrations for suppori
Participants complete a group exercise to recap the content of Lesson 3.
````{card}
Exercise --- Implement a Collaborative Workflow
Exercise 1 --- Implement a Collaborative Workflow
^^^
```{include} exercises/L4-ex01.md
Expand All @@ -52,14 +52,39 @@ Exercise --- Implement a Collaborative Workflow
> This lesson will be completed later.
````{card}
Exercise 2 --- Code Reviews [10 mins]
^^^
```{include} exercises/L4-ex02.md
```
````
### 4.1.2. Contributing Guidelines
````{card}
Exercise 3 --- Guidelines for Contributions [10 mins]
^^^
```{include} exercises/L4-ex03.md
```
````
## Episode 2: Licensing and Citation
### 4.2.1. Open Source Licenses
### 4.2.2. Software Citation
````{card}
Exercise 3 --- hoosing Licenses and Enabling Software Citation [10 mins]
^^^
```{include} exercises/L4-ex04.md
```
````
## Episode 3: Releasing Software
### 4.3.1. Semantic Versioning
Expand Down

0 comments on commit 654a550

Please sign in to comment.