A The Carpentries Incubator

The Carpentries Incubator is where The Carpentries community develops curricula together. It is intended to serve as a place to find and contribute to lessons that members of our community are developing with the approaches and infrastructure introduced in this handbook.

A.1 Lesson Proposals

Proposals to begin development of a new lesson in the Incubator, and to transfer existing material (regardless of its current state/stage of development) into the Incubator, can be made by opening an issue on the Proposals GitHub repository. The requirements are minimal for a proposal to be accepted, predominantly designed to maintain consistency across the community’s lessons. The README of that repository contains more detailed guidance for those who wish to submit a proposal.

A.2 Topic Tags

Lessons under community development in the Carpentries Incubator are listed on The Carpentries website, based on metadata describing the lesson. This metadata is added in the form of topic tags on the lesson repository. These topic tags should be set as soon as possible after the lesson has been created or added to the Incubator. Some are essential and taken from a limited set of values, while others are more flexible. See the table below for guidance about the types and number of topic tags each lesson repository should have.

Category Example Number Description
Lesson* lesson 1 Must be lesson to be listed on the Community Developed Lessons page.
Location* carpentries-incubator 1 carpentries-incubator or carpentrieslab.
Language* español >0 The language(s) the lesson is available in.
Stage* alpha 1 The current development stage for the lesson. See Chapter 7 for more info.
Domain microbial-ecology 1-2 The high-level domain(s) of the lesson, for a general categorization.
Tools python 1-3 The main tool(s) taught in the lesson.
Skills taxonomic-classification 1-3 The main skill(s) taught in the lesson.

Categories marked with an asterisk (*) are required in order for a lesson to appear and be appropriately sorted on the Community Developed Lessons page.

The Curriculum Team will support you in setting appropriate topic tags for your lesson. To help ensure consistency across all lesson repositories developed by The Carpentires community, please refer to this listing of topic tags currently in use in The Carpentries Incubator, and re-use these values where appropriate, creating new topic tags where no pre-existing label exists for your lesson.

A.3 Using GitHub Issue Labels

GitHub allows the maintainers of a repository to add contextual information to Issues and Pull Requests in the form of labels. Visit the How to Label Issues page of The Carpentries handbook for a list of the labels used on official Carpentries lesson repositories and to read recommendations on how to use them for your own lesson.

A.3.1 Using Labels to Encourage Contributions

Two labels, used by The Carpentries and in many repositories across GitHub, can be deployed to increase the visibility of your lesson and encourage community members to contribute to its development.

The “help wanted” label should be used to highlight issues with which you would welcome additional help. The Carpentries website includes a Help Wanted page, which can automatically list every issue labelled “help wanted” on repositories from The Carpentries, Software Carpentry, Data Carpentry, Library Carpentry, CarpentriesLab, and The Carpentries Incubator. Find out how to include issues from your lesson repository on the Help Wanted page by reading the Information for Maintainers on the page itself.

The “good first issue” label should be used to identify issues that would make a good entry point for newcomers looking for a way to contribute to your lesson. The work needed to close an issue with this label would typically not require an extensive knowledge of the structure or intricacies of your lesson repository, or an expert understanding of the content. The “good first issue” label is used so extensively that GitHub provides a page at [repository URL]/contribute for every repository, listing issues with this label.