CONTRIBUTING.md

   1 ---
   2 layout: page
   3 title: "Contributing"
   4 ---
   5 # Contributing
   6
   7 [Arvados](https://arvados.org) is an open source project,
   8 and we welcome contributions of all kinds:
   9 new lessons,
  10 fixes to existing material,
  11 bug reports,
  12 and reviews of proposed changes are all welcome.
  13
  14 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
  15 mirrored at <https://github.com/common-workflow-lab/rnaseq-cwl-training>.
  16
  17 ## Contributor Agreement
  18
  19 By contributing,
  20 you agree that we may redistribute your work under [our license](LICENSE.md).
  21 In exchange,
  22 we will address your issues and/or assess your change proposal as promptly as we can,
  23 and help you become a member of our community.
  24 Everyone involved
  25 agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
  26
  27 ## How to Contribute
  28
  29 The easiest way to get started is to file an issue
  30 to tell us about a spelling mistake,
  31 some awkward wording,
  32 or a factual error.
  33 This is a good way to introduce yourself
  34 and to meet some of our community members.
  35
  36 1.  If you do not have a [GitHub][github] account,
  37     you can [send us comments by email][email].
  38     However,
  39     we will be able to respond more quickly if you use one of the other methods described below.
  40
  41 2.  If you have a [GitHub][github] account,
  42     or are willing to [create one][github-join],
  43     but do not know how to use Git,
  44     you can report problems or suggest improvements by [creating an issue][issues].
  45     This allows us to assign the item to someone
  46     and to respond to it in a threaded discussion.
  47
  48 3.  If you are comfortable with Git,
  49     and would like to add or change material,
  50     you can submit a pull request (PR).
  51     Instructions for doing this are [included below](#using-github).
  52
  53 ## Where to Contribute
  54
  55 1.  If you wish to change this lesson,
  56     please make a pull request against <https://github.com/common-workflow-lab/rnaseq-cwl-training>.
  57
  58 ## What to Contribute
  59
  60 There are many ways to contribute,
  61 from writing new exercises and improving existing ones
  62 to updating or filling in the documentation
  63 and submitting [bug reports][issues]
  64 about things that do not work, aren not clear, or are missing.
  65 If you are looking for ideas, please see the 'Issues' tab for
  66 a list of issues associated with this repository.
  67
  68 Comments on issues and reviews of pull requests are just as welcome:
  69 we are smarter together than we are on our own.
  70 Reviews from novices and newcomers are particularly valuable:
  71 it is easy for people who have been using these lessons for a while
  72 to forget how impenetrable some of this material can be,
  73 so fresh eyes are always welcome.
  74
  75
  76 ## Using GitHub
  77
  78 If you choose to contribute via GitHub, you may want to look at
  79 [How to Contribute to an Open Source Project on GitHub][how-contribute].
  80 Each lesson has two maintainers who review issues and pull requests or encourage others to do so.
  81 The maintainers are community volunteers and have final say over what gets merged into the lesson.
  82 To use the web interface for contributing to a lesson:
  83
  84 1.  Fork the originating repository to your GitHub profile.
  85 2.  Within your version of the forked repository, move to the `gh-pages` branch and
  86 create a new branch for each significant change being made.
  87 3.  Navigate to the file(s) you wish to change within the new branches and make revisions as required.
  88 4.  Commit all changed files within the appropriate branches.
  89 5.  Create individual pull requests from each of your changed branches
  90 to the `gh-pages` branch within the originating repository.
  91 6.  If you receive feedback, make changes using your issue-specific branches of the forked
  92 repository and the pull requests will update automatically.
  93 7.  Repeat as needed until all feedback has been addressed.
  94
  95 When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
  96 before creating your own revision-specific branch(es) from there.
  97 Additionally, please only work from your newly-created branch(es) and *not*
  98 your clone of the originating `gh-pages` branch.
  99 Lastly, published copies of all the lessons are available in the `gh-pages` branch of the originating
 100 repository for reference while revising.
 101
 102 ## Other Resources
 103
 104 General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
 105 happens on the [discussion mailing list][discuss-list],
 106 which everyone is welcome to join.
 107 You can also [reach us by email][email].
 108
 109 [email]: mailto:admin@software-carpentry.org
 110 [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
 111 [dc-lessons]: http://datacarpentry.org/lessons/
 112 [dc-site]: http://datacarpentry.org/
 113 [discuss-list]: https://carpentries.topicbox.com/groups/discuss
 114 [github]: https://github.com
 115 [github-flow]: https://guides.github.com/introduction/flow/
 116 [github-join]: https://github.com/join
 117 [how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
 118 [issues]: https://guides.github.com/features/issues/
 119 [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
 120 [swc-lessons]: https://software-carpentry.org/lessons/
 121 [swc-site]: https://software-carpentry.org/
 122 [c-site]: https://carpentries.org/
 123 [lc-site]: https://librarycarpentry.org/
 124 [lc-issues]: https://github.com/issues?q=user%3Alibrarycarpentry