|
1 |
| -# How to Contribute |
| 1 | +# Contributing |
2 | 2 |
|
3 |
| -Software Carpentry is an open source project, |
| 3 | +[Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects, |
4 | 4 | and we welcome contributions of all kinds:
|
5 | 5 | new lessons,
|
6 | 6 | fixes to existing material,
|
7 | 7 | bug reports,
|
8 |
| -and reviews of proposed changes are all equally welcome. |
| 8 | +and reviews of proposed changes are all welcome. |
| 9 | + |
| 10 | +## Contributor Agreement |
9 | 11 |
|
10 | 12 | By contributing,
|
11 |
| -you are agreeing that Software Carpentry may redistribute your work under |
12 |
| -[these licenses][license]. |
13 |
| -You also agree to abide by our |
14 |
| -[contributor code of conduct][conduct]. |
| 13 | +you agree that we may redistribute your work under [our license](LICENSE.md). |
| 14 | +In exchange, |
| 15 | +we will address your issues and/or assess your change proposal as promptly as we can, |
| 16 | +and help you become a member of our community. |
| 17 | +Everyone involved in [Software Carpentry][swc-site] and [Data Carpentry][dc-site] |
| 18 | +agrees to abide by our [code of conduct](CONDUCT.md). |
| 19 | + |
| 20 | +## How to Contribute |
| 21 | + |
| 22 | +The easiest way to get started is to file an issue |
| 23 | +to tell us about a spelling mistake, |
| 24 | +some awkward wording, |
| 25 | +or a factual error. |
| 26 | +This is a good way to introduce yourself |
| 27 | +and to meet some of our community members. |
| 28 | + |
| 29 | +1. If you do not have a [GitHub][github] account, |
| 30 | + you can [send us comments by email][contact]. |
| 31 | + However, |
| 32 | + we will be able to respond more quickly if you use one of the other methods described below. |
| 33 | + |
| 34 | +2. If you have a [GitHub][github] account, |
| 35 | + or are willing to [create one][github-join], |
| 36 | + but do not know how to use Git, |
| 37 | + you can report problems or suggest improvements by [creating an issue][issues]. |
| 38 | + This allows us to assign the item to someone |
| 39 | + and to respond to it in a threaded discussion. |
| 40 | + |
| 41 | +3. If you are comfortable with Git, |
| 42 | + and would like to add or change material, |
| 43 | + you can submit a pull request (PR). |
| 44 | + Instructions for doing this are [included below](#using-github). |
| 45 | + |
| 46 | +## What We're Looking For |
| 47 | + |
| 48 | +There are many ways to contribute, |
| 49 | +from writing new exercises and improving existing ones |
| 50 | +to updating or filling in the documentation |
| 51 | +and and submitting [bug reports][issues] |
| 52 | +about things that don't work, aren't clear, or are missing. |
| 53 | +If you are looking for ideas, |
| 54 | +please see [the list of issues for this repository][issues], |
| 55 | +or the issues for [Data Carpentry][dc-issues] |
| 56 | +and [Software Carpentry][swc-issues] projects. |
| 57 | + |
| 58 | +Comments on issues and reviews of pull requests are just as welcome: |
| 59 | +we are smarter together than we are on our own. |
| 60 | +Reviews from novices and newcomers are particularly valuable: |
| 61 | +it's easy for people who have been using these lessons for a while |
| 62 | +to forget how impenetrable some of this material can be, |
| 63 | +so fresh eyes are always welcome. |
| 64 | + |
| 65 | +## What We're *Not* Looking For |
| 66 | + |
| 67 | +Our lessons already contain more material than we can cover in a typical workshop, |
| 68 | +so we are usually *not* looking for more concepts or tools to add to them. |
| 69 | +As a rule, |
| 70 | +if you want to introduce a new idea, |
| 71 | +you must (a) estimate how long it will take to teach |
| 72 | +and (b) explain what you would take out to make room for it. |
| 73 | +The first encourages contributors to be honest about requirements; |
| 74 | +the second, to think hard about priorities. |
| 75 | + |
| 76 | +We are also not looking for exercises or other material that only run on one platform. |
| 77 | +Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users; |
| 78 | +in order to be usable, |
| 79 | +our lessons must run equally well on all three. |
15 | 80 |
|
16 | 81 | ## Getting Started
|
17 | 82 |
|
18 |
| -1. We use GitHub flow to manage changes, |
19 |
| - which is explained in the chapter [Contributing to a Project][pro-git-chapter] |
20 |
| - in Scott Chacon's book *Pro Git*. |
| 83 | +The easiest way to get started is to file an issue |
| 84 | +to tell us about a spelling mistake, |
| 85 | +some awkward wording, |
| 86 | +or a factual error. |
| 87 | +This is a good way to introduce yourself |
| 88 | +and to meet some of our community members. |
| 89 | + |
| 90 | +If you want to start adding or fixing material yourself, |
| 91 | +you may want to look at |
| 92 | +[How to Contribute to an Open Source Project on GitHub][how-contribute]. |
| 93 | +In brief: |
| 94 | + |
| 95 | +1. The published copy of the lesson is in the `gh-pages` branch of the repository |
| 96 | + (so that GitHub will regenerate it automatically). |
| 97 | + Please create all branches from that, |
| 98 | + and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch |
| 99 | + before starting work. |
| 100 | + Please do *not* work directly in your `gh-pages` branch, |
| 101 | + since that will make it difficult for you to work on other contributions. |
| 102 | + |
| 103 | +2. We use [GitHub flow][github-flow] to manage changes: |
| 104 | + 1. Create a new branch in your desktop copy of this repository for each significant change. |
| 105 | + 2. Commit the change in that branch. |
| 106 | + 3. Push that branch to your fork of this repository on GitHub. |
| 107 | + 4. Submit a pull request from that branch to the [master repository][repo]. |
| 108 | + 5. If you receive feedback, |
| 109 | + make changes on your desktop and push to your branch on GitHub: |
| 110 | + the pull request will update automatically. |
| 111 | + |
| 112 | +Each lesson has two maintainers who review issues and pull requests |
| 113 | +or encourage others to do so. |
| 114 | +The maintainers are community volunteers, |
| 115 | +and have final say over what gets merged into the lesson. |
| 116 | + |
| 117 | +## Our Template |
21 | 118 |
|
22 |
| -2. You should branch from and submit pull requests against the `gh-pages` branch of this repository. |
| 119 | +[This documentation][example-site] explains how we format our lessons |
| 120 | +(and is itself an example of that formatting). |
23 | 121 |
|
24 | 122 | ## Other Resources
|
25 | 123 |
|
26 |
| -This lesson is based on the template found at |
27 |
| -[https://github.com/swcarpentry/workshop-template][workshop-template]. |
28 |
| -That repository has instructions on formatting and previewing workshop websites. |
| 124 | +General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site] |
| 125 | +happens on the [discussion mailing list][discuss-list], |
| 126 | +which everyone is welcome to join. |
| 127 | +You can also [reach us by email][contact]. |
29 | 128 |
|
30 |
| -[conduct]: CONDUCT.md |
31 |
| -[license]: LICENSE.md |
32 |
| -[pro-git-chapter]: http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project |
33 |
| -[workshop-template]: https://github.com/swcarpentry/workshop-template |
| 129 | +[contact]: mailto:[email protected] |
| 130 | +[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry |
| 131 | +[dc-lessons]: http://datacarpentry.org/lessons/ |
| 132 | +[dc-site]: http://datacarpentry.org/ |
| 133 | +[discuss-list]: http://lists.software-carpentry.org/listinfo/discuss |
| 134 | +[example-site]: https://swcarpentry.github.io/lesson-example/ |
| 135 | +[github]: http://github.com |
| 136 | +[github-flow]: https://guides.github.com/introduction/flow/ |
| 137 | +[github-join]: https://github.com/join |
| 138 | +[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github |
| 139 | +[issues]: https://github.com/swcarpentry/workshop-template/issues/ |
| 140 | +[repo]: https://github.com/swcarpentry/workshop-template/ |
| 141 | +[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry |
| 142 | +[swc-lessons]: http://software-carpentry.org/lessons/ |
| 143 | +[swc-site]: http://software-carpentry.org/ |
0 commit comments