Skip to content

Latest commit

 

History

History
146 lines (117 loc) · 6.41 KB

CONTRIBUTING.md

File metadata and controls

146 lines (117 loc) · 6.41 KB
Raw

There are three main ways to contribute to Library Carpentry:

  • Join our Gitter discussion forum. Here you can suggest new content, volunteer to become a lesson maintainer, or help shape future developments.
  • Suggest an improvement or correct an error by raising an Issue.
  • Run a workshop at your own institution! If you do, alert us on Gitter: we’re happy to help promote the workshop and offer guidance on running it. Remember, there is no better way to deepen your own knowledge of software skills than to teach others.

Otherwise, Library Carpentry builds on the work of Software Carpentry and Data Carpentry. It uses the same contribution guidelines as these projects. This can be found below.

Contributing

Software Carpentry and Data 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 Software Carpentry and Data Carpentry 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.

What We're Looking For

There are many ways to contribute, from writing new exercises and improving existing ones to updating or filling in the documentation and and submitting bug reports about things that don't work, aren't clear, or are missing. If you are looking for ideas, please see the list of issues for this repository, or the issues for Data Carpentry and Software Carpentry projects.

Comments on issues and reviews of pull requests are just as welcome: we are smarter together than we are on our own. Reviews from novices and newcomers are particularly valuable: it's easy for people who have been using these lessons for a while to forget how impenetrable some of this material can be, so fresh eyes are always welcome.

What We're Not Looking For

Our lessons already contain more material than we can cover in a typical workshop, so we are usually not looking for more concepts or tools to add to them. As a rule, if you want to introduce a new idea, you must estimate how long it will take to teach and explain what you would take out to make room for it. The first encourages contributors to be honest about requirements; the second, to think hard about priorities.

We are also not looking for exercises or other material that only run on one platform. Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users; in order to be usable, our lessons must run equally well on all three.

Using GitHub

If you want to start adding or fixing material yourself, you may want to look at How to Contribute to an Open Source Project on GitHub. In brief:

  1. The published copy of the lesson is in the gh-pages branch of the repository (so that GitHub will regenerate it automatically). Please create all branches from that, and merge the master repository's gh-pages branch into your gh-pages branch before starting work. Please do not work directly in your gh-pages branch, since that will make it difficult for you to work on other contributions.

  2. 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 master repository.
    5. If you receive feedback, make changes on your desktop and push to your branch on GitHub: the pull request will update automatically.

Each lesson has two 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.

Our Template

This documentation explains how we format our lessons (and is itself an example of that formatting).

Other Resources

General discussion of Software Carpentry and Data Carpentry happens on the discussion mailing list, which everyone is welcome to join. You can also [reach us by email][mailto:[email protected]].