generated from manuGil/fair-code
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #18 from manuGil/exercises/lesson4
add exercies of lesson 4
- Loading branch information
Showing
7 changed files
with
67 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters