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