acenet-arc/git-collaboration

SWC-like Workshop on using Git-Collaboration sites.

FIXME Lesson title

FIXME

Contributing

We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any questions, concerns, or experience any difficulties along the way.

We'd like to ask you to familiarize yourself with our Contribution Guide and have a look at the more detailed guidelines on proper formatting, ways to render the lesson locally, and even how to write new episodes.

Maintainer(s)

• FIXME

Authors

A list of contributors to the lesson can be found in AUTHORS

Citation

To cite this lesson, please consult with CITATION

git-collaboration's Issues

CI objective still mentions "Travis"

• Setting up Continuous Integration for a Python project with GitHub and Travis

The lesson now uses GitHub actions instead of Travis

Note: Timing of workshop held on 2022-11-14

started ca. 5 min late

1. Introduction: 10 min
2. Hosting Platforms: 10 min
3. Issues: 10 min
4. Forking: 10 min
5. Pull requests: 35 min
6. Code review: 5 min
7. Break: 15 min
8. Branches: 45 min
9. CI: 30 min
10. Tags: 25 min
11. Wiki: 5 min
12. Pages: 15-20 min

Add episode on "citation"

The CITATION.cff is a standardized file format where the owner of a repository can specify how the repository is supposed to be cited.

See: https://citation-file-format.github.io/

The section about citable releases, which is part of the episode "Tags and Releases" could be moved to this one as well.

Wiki episode: GH-pages URL is mangled

• repository will be available under “https://.github.io".

<username> is interpreted as an HTML tag.

Fix challenge in “Pull-Request”

The challenge in _episodes/05-Pull-Requests.md says that the file should be downloaded, even though it's in the more_files directory.

The shell code below is correct.

write episode on branching

• stub page already exists: _episodes/09-Branches.md
• git graphs could be created with mermaid.js
  • last time I checked, embedding the javascript and writing mermaid code in the markdown didn't work reliably.
  • maybe a better strategy would be to create the graphs as .svg files with mermaid-cli and then add both the source files, .svg graphics and a README on how to recreate them.
• good material to draw from:
  • Interactive Tutorial: https://pcottle.github.io/learnGitBranching/
    • Sandbox-mode: can be used to demo/practice: https://pcottle.github.io/learnGitBranching/?NODEMO
  • eBook "Pro Git": https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell

Add links to additional learning material

In file reference.md add a section for additional learning material.

e.g.:

• https://swcarpentry.github.io/git-novice/
• https://pcottle.github.io/learnGitBranching/
• eBook "Pro Git": git-scm/book/en/v2
• Training pages from GitHub, GitLab, Bitbucket,

Testing demo page: update links to python testing

The README.md of the testing_demo repo contains
outdated links to Katy Huff's Python-testing lesson.

New URLs are:

• Site: https://carpentries-incubator.github.io/python-testing/
• Repo: https://github.com/carpentries-incubator/python-testing/

Improve "Instructor notes"

• _extras/guide.md

Change episode 7 (Continuous Integration) to use GitHub actions instead of Travis.

GitHub has introduced "GitHub Actions" a few years ago.
Therefore those should be covered.

The part on Travis is no longer needed.

update overview site

GitHub has expanded their services over the past year:

• GitHub now allows private repos for free, but restricts the number of collaborators
• GitHub Actions is a new service for CI directly by GitHub
  • Also allows you to use your own runners like GitLab does
• GitHub Packages allows to publish packages for select package managers (e.g. npm, docker, Maven, RubyGems)

Current page _episodes/02-Hosting-Platforms.md

Improve Branching episode

• start with clone and add a few pushes to remote
• draw boxes around GitHub (mermaid subgraphs);
• maybe also boxes around local repo as well (test and see how it looks)

reorder episodes a bit

• Episodes Issue Tracker, Forking, Pull Requests and Code Review are tightly coupled and should stay together.
• A good place to insert a 15 min break is after Code Review
• Move Branches right after the break
• Continuous Integration can be pushed after Tags and Releases or even later
• Add another 5 minute break. Maybe after CI ?

Improve introduction

Add introductory text to the Intro episode to add context (could note that the git-novice lesson is a prerequisite), and fix "keypoints" frontmatter.