This lesson is being piloted (Beta version)

Contributing to lesson materials

Carpentries lessons are all hosted on GitHub, and contributing to them requires familiarity with:

Today’s skill-up session tackles all of these topics.

Prerequisites

Learners should be familiar with using Git:

  • making commits
  • working in feature branches
  • pushing to a remote repository

This lesson uses Git from the command line, and so is easiest followed from a command prompt.

Jekyll is used to build a local copy of the lessons — it isn’t absolutely required to follow this course, but would be very useful if you could install jekyll on your machine.

Schedule

Setup Download files required for the lesson
00:00 1. Making a Pull Request How can I collaborate on a project using Git?
What is a remote repository?
How can I collaborate if I don’t have write access?
What files should I edit in a Carpentries lesson repo?
How can I preview my changes?
00:20 2. Adding to a Pull Request How do I make changes to an existing PR?
00:30 3. Keeping your fork up-to-date How do I keep my fork up to date with the Carpentries repository?
How do I resolve a merge conflict in my PR?
00:50 4. What makes a good Pull Request When should I create an issue?
What makes a good PR?
How can I make my PR easy to review?
What makes my PR more likely to be merged quickly?
01:05 5. Contributing directly on GitHub How can I contribute to a lesson using only GitHub?
What are the limitations of using GitHub like this?
01:15 Finish

The actual schedule may vary slightly depending on the topics and exercises chosen by the instructor.