|
89 | 89 | to updating or filling in the documentation
|
90 | 90 | and and submitting [bug reports][issues]
|
91 | 91 | about things that don't work, aren't clear, or are missing.
|
92 |
| -If you are looking for ideas, |
93 |
| -please see [the list of issues for this repository][issues], |
94 |
| -or the issues for [Data Carpentry][dc-issues] |
| 92 | +If you are looking for ideas, please see the 'Issues' tab for |
| 93 | +a list of issues associated with this repository, |
| 94 | +or you may also look at the issues for [Data Carpentry][dc-issues] |
95 | 95 | and [Software Carpentry][swc-issues] projects.
|
96 | 96 |
|
97 | 97 | Comments on issues and reviews of pull requests are just as welcome:
|
|
119 | 119 |
|
120 | 120 | ## Using GitHub
|
121 | 121 |
|
122 |
| -If you choose to contribute via GitHub, |
123 |
| -you may want to look at |
| 122 | +If you choose to contribute via GitHub, you may want to look at |
124 | 123 | [How to Contribute to an Open Source Project on GitHub][how-contribute].
|
125 |
| -In brief: |
126 |
| -
|
127 |
| -1. The published copy of the lesson is in the `gh-pages` branch of the repository |
128 |
| - (so that GitHub will regenerate it automatically). |
129 |
| - Please create all branches from that, |
130 |
| - and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch |
131 |
| - before starting work. |
132 |
| - Please do *not* work directly in your `gh-pages` branch, |
133 |
| - since that will make it difficult for you to work on other contributions. |
134 |
| -
|
135 |
| -2. We use [GitHub flow][github-flow] to manage changes: |
136 |
| - 1. Create a new branch in your desktop copy of this repository for each significant change. |
137 |
| - 2. Commit the change in that branch. |
138 |
| - 3. Push that branch to your fork of this repository on GitHub. |
139 |
| - 4. Submit a pull request from that branch to the [master repository][repo]. |
140 |
| - 5. If you receive feedback, |
141 |
| - make changes on your desktop and push to your branch on GitHub: |
142 |
| - the pull request will update automatically. |
143 |
| -
|
144 |
| -Each lesson has two maintainers who review issues and pull requests |
145 |
| -or encourage others to do so. |
146 |
| -The maintainers are community volunteers, |
147 |
| -and have final say over what gets merged into the lesson. |
| 124 | +To manage changes, we follow [GitHub flow][github-flow]. |
| 125 | +Each lesson has two maintainers who review issues and pull requests or encourage others to do so. |
| 126 | +The maintainers are community volunteers and have final say over what gets merged into the lesson. |
| 127 | +To use the web interface for contributing to a lesson: |
| 128 | +
|
| 129 | +1. Fork the master repository to your GitHub profile. |
| 130 | +2. Within your version of the forked repository, move to the `gh-pages` branch and |
| 131 | +create a new branch for each significant change being made. |
| 132 | +3. Navigate to the file(s) you wish to change within the new branches and make revisions as required. |
| 133 | +4. Commit all changed files within the appropriate branches. |
| 134 | +5. Create individual pull requests from each of your changed branches |
| 135 | +to the `gh-pages` branch within the master repository. |
| 136 | +6. If you receive feedback, make changes using your issue-specific branches of the forked |
| 137 | +repository and the pull requests will update automatically. |
| 138 | +7. Repeat as needed until all feedback has been addressed. |
| 139 | +
|
| 140 | +When starting work, please make sure your clone of the master `gh-pages` branch is up-to-date |
| 141 | +before creating your own revision-specific branch(es) from there. |
| 142 | +Additionally, please only work from your newly-created branch(es) and *not* |
| 143 | +your clone of the master `gh-pages` branch. |
| 144 | +Lastly, published copies of all the lessons are available in the `gh-pages` branch of the master |
| 145 | +repository for reference while revising. |
148 | 146 |
|
149 | 147 | ## Other Resources
|
150 | 148 |
|
|
162 | 160 | [github-flow]: https://guides.github.com/introduction/flow/
|
163 | 161 | [github-join]: https://github.com/join
|
164 | 162 | [how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
|
165 |
| -[issues]: https://github.com/swcarpentry/FIXME/issues/ |
166 |
| -[repo]: https://github.com/swcarpentry/FIXME/ |
| 163 | +[issues]: https://guides.github.com/features/issues/ |
167 | 164 | [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
|
168 | 165 | [swc-lessons]: https://software-carpentry.org/lessons/
|
169 | 166 | [swc-site]: https://software-carpentry.org/
|
|
0 commit comments