https://github.com/digital-work-lab/open-source-collaboration-game
https://github.com/digital-work-lab/open-source-collaboration-game
Science Score: 49.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 3 DOI reference(s) in README -
✓Academic publication links
Links to: zenodo.org -
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.9%) to scientific vocabulary
Keywords
Repository
Basic Info
Statistics
- Stars: 0
- Watchers: 1
- Forks: 2
- Open Issues: 0
- Releases: 1
Topics
Metadata Files
readme.md
The Open-Source Collaboration Game
-blue){kind=icon}
The goals of this tutorial are to
- Learn how to use the collaboration features of Git, including forks, pull requests, merges, and issues
- Apply them in a realistic setting of multiple contributors without requiring time to write code
- Familiarize with the key elements of open-source project documentation
In the following, we simulate a small Open-Source community that updates the documentation for an example project. <!-- (CoLRev). This project provides an extensible platform to support the whole literature review process from the search to the selection of relevant papers, the retrieval of PDFs, and the synthesis. -->
Students will split into small groups and one maintainer group, which will lead the project and use the beamer to show their work.
Preparation
- Create a GitHub account
- Select two maintainers, form up to 7 teams (1-3 students each)
- Give the maintainers 5 minutes to prepare
Round 1 (Maintainers)
- Create the project and ask for contributions (based on playbook M1)
Round 2 (Contributors)
Each group works in their issue based on the following playbooks (playbooks with 🎓 are slightly more challenging):
- Playbook C1 - Goals 🎓
- Playbook C2 - Getting started
- Playbook C3 - Example
- Playbook C4 - Documentation 🎓
- Playbook C5 - Contributing guidelines
- Playbook C6 - FAQ
- Playbook C7 - Using CoLRev for interview data
The maintainers read playbook M2 to prepare for the next round
Round 3 (Maintainers)
- Review the contributions, assign them to issues (based on playbook M2)
Round 2 (Contributors)
- Each group updates the
nav_ordervalues and adds links to the other pages (the links are optional) - Group 7 has a separate playbook
- The maintainers prepare for the next round
Round 4 (Maintainers)
- Conclude the session and provide a brief outlook (based on playbook M3)
Round 5 (Clean-up)
- Take notes on the changes that were introduced and the key elements of the GitHub/Open-Source workflow that were covered in this session
License
The contents are licensed under the CC-BY 4.0 License.
Owner
- Name: digital-work-lab
- Login: digital-work-lab
- Kind: organization
- Repositories: 1
- Profile: https://github.com/digital-work-lab
GitHub Events
Total
- Push event: 2
- Fork event: 1
Last Year
- Push event: 2
- Fork event: 1