Skip to content

Latest commit

 

History

History
91 lines (72 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

91 lines (72 loc) · 4.12 KB
Raw

Contributing

The Carpentries (Software Carpentry, Data Carpentry, and Library Carpentry) are open source projects, and we welcome contributions of all kinds: new lessons, fixes to existing material, bug reports, and reviews of proposed changes are all welcome.

Contributor Agreement

By contributing, you agree that we may redistribute your work under our license. In exchange, we will address your issues and/or assess your change proposal as promptly as we can, and help you become a member of our community. Everyone involved in The Carpentries agrees to abide by our code of conduct.

How to Contribute

The easiest way to get started is to file an issue to tell us about a spelling mistake, some awkward wording, or a factual error. This is a good way to introduce yourself and to meet some of our community members.

  1. If you do not have a GitHub account, you can send us comments by email. However, we will be able to respond more quickly if you use one of the other methods described below.

  2. If you have a GitHub account, or are willing to create one, but do not know how to use Git, you can report problems or suggest improvements by creating an issue. This allows us to assign the item to someone and to respond to it in a threaded discussion.

  3. If you are comfortable with Git, and would like to add or change material, you can submit a pull request (PR). Instructions for doing this are included below.

Note: if you want to build the website locally, please refer to The Workbench documentation.

Where to Contribute

  1. If you wish to change this lesson, add issues and pull requests here.
  2. If you wish to change the template used for workshop websites, please refer to The Workbench documentation.

Using GitHub

If you choose to contribute via GitHub, you may want to look at How to Contribute to an Open Source Project on GitHub. In brief, we use GitHub flow to manage changes:

  1. Create a new branch in your desktop copy of this repository for each significant change.
  2. Commit the change in that branch.
  3. Push that branch to your fork of this repository on GitHub.
  4. Submit a pull request from that branch to the upstream repository.
  5. If you receive feedback, make changes on your desktop and push to your branch on GitHub: the pull request will update automatically.

NB: The published copy of the lesson is usually in the main branch.

Each lesson has a team of maintainers who review issues and pull requests or encourage others to do so. The maintainers are community volunteers, and have final say over what gets merged into the lesson.

Other Resources

The Carpentries is a global organisation with volunteers and learners all over the world. We share values of inclusivity and a passion for sharing knowledge, teaching and learning. There are several ways to connect with The Carpentries community listed at https://carpentries.org/connect/ including via social media, slack, newsletters, and email lists. You can also reach us by email.