Skip to content

Latest commit

 

History

History
73 lines (58 loc) · 3.46 KB

CONTRIBUTING.md

File metadata and controls

73 lines (58 loc) · 3.46 KB

Contributing

Everyone involved in Carpentry@UiO agrees to abide by our code of conduct.

How to Contribute

The easiest way to get started is to create 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, or want to avoid using it, 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. You can also propose a change directly, by first editing the relevant file on this-repo, and then follow the instructions given to submit a pull request (PR).

  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.

Staff from the UiO library as well as some of the Carpentry@UiO volunteers will review issues and pull requests or encourage others to do so. The people are community volunteers, and have final say over what gets merged into the lesson.

Using GitHub with git

If you choose to contribute via GitHub using git, you may want to look at How to Contribute to an Open Source Project on GitHub. In brief:

  1. We use GitHub flow to manage changes:

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

  2. The published copy of the material is in the master branch of [this repository][this-repo]

    1. Please keep the master branch of your fork up to date with the one from this repository
    2. Create all branches from that up to date master branch in your fork
    3. Please do not work directly in your fork's master branch, since that will make it difficult for you to work on other contributions

This document is modified from the contributing guidelines for The carpentries Instructor Training material, as allowed under their CC BY 4.0 license.

this-repo