+---
+layout: page
+title: "Contributing"
+---
# Contributing
-[The Carpentries][c-site] ([Software Carpentry][swc-site], [Data Carpentry][dc-site], and [Library Carpentry][lc-site]) are open source projects,
+[Arvados](https://arvados.org) is an open source project,
and we welcome contributions of all kinds:
new lessons,
fixes to existing material,
bug reports,
and reviews of proposed changes are all welcome.
+The source to this lesson can be found at [git.arvados.org/rnaseq-cwl-training.git](https://git.arvados.org/rnaseq-cwl-training.git/), it is also
+mirrored at <https://github.com/common-workflow-lab/rnaseq-cwl-training>.
+
## Contributor Agreement
By contributing,
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][c-site]
+Everyone involved
agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
## How to Contribute
## Where to Contribute
1. If you wish to change this lesson,
- please work in <https://github.com/swcarpentry/FIXME>,
- which can be viewed at <https://swcarpentry.github.io/FIXME>.
-
-2. If you wish to change the example lesson,
- please work in <https://github.com/carpentries/lesson-example>,
- which documents the format of our lessons
- and can be viewed at <https://carpentries.github.io/lesson-example>.
-
-3. If you wish to change the template used for workshop websites,
- please work in <https://github.com/carpentries/workshop-template>.
- The home page of that repository explains how to set up workshop websites,
- while the extra pages in <https://carpentries.github.io/workshop-template>
- provide more background on our design choices.
-
-4. If you wish to change CSS style files, tools,
- or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
- please work in <https://github.com/carpentries/styles>.
+ please make a pull request against <https://github.com/common-workflow-lab/rnaseq-cwl-training>.
## What to Contribute
and submitting [bug reports][issues]
about things that do not work, aren not clear, or are missing.
If you are looking for ideas, please see the 'Issues' tab for
-a list of issues associated with this repository,
-or you may also look at the issues for [Data Carpentry][dc-issues],
-[Software Carpentry][swc-issues], and [Library Carpentry][lc-issues] projects.
+a list of issues associated with this repository.
Comments on issues and reviews of pull requests are just as welcome:
we are smarter together than we are on our own.
to forget how impenetrable some of this material can be,
so fresh eyes are always welcome.
-## What *Not* to Contribute
-
-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 (a) estimate how long it will take to teach
-and (b) 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, macOS, and Linux users;
-in order to be usable,
-our lessons must run equally well on all three.
## 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][how-contribute].
-To manage changes, we follow [GitHub flow][github-flow].
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.
To use the web interface for contributing to a lesson:
projects / rnaseq-cwl-training.git / blobdiff