Skip to content

Commit 8404c00

Browse files
committed
Updated lesson_initialize
Clarified instructions for using GitHub to contribute, altered link for [issues] to direct to GitHub page on navigating issues to avoid FIXME issue with link when initializing, removed link to master repo to avoid FIXME issue with link when initializing. These suggestions were based on a pull request initially done elsewhere swcarpentry/shell-novice#639
1 parent 95644a9 commit 8404c00

File tree

1 file changed

+28
-33
lines changed

1 file changed

+28
-33
lines changed

bin/lesson_initialize.py

Lines changed: 28 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
and to meet some of our community members.
4646
4747
1. If you do not have a [GitHub][github] account,
48-
you can [send us comments by email][email].
48+
you can [send us comments by email][contact].
4949
However,
5050
we will be able to respond more quickly if you use one of the other methods described below.
5151
@@ -89,9 +89,9 @@
8989
to updating or filling in the documentation
9090
and and submitting [bug reports][issues]
9191
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]
9595
and [Software Carpentry][swc-issues] projects.
9696
9797
Comments on issues and reviews of pull requests are just as welcome:
@@ -119,41 +119,37 @@
119119
120120
## Using GitHub
121121
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
124123
[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+
A published copy of the lesson is available in the `gh-pages` branch of the master repository.
125+
Before starting work, please make sure your clone of the master `gh-pages` branch is up-to-date
126+
and create your own revision-specific branch(es) from there.
127+
Please only work on your newly-created branch(es) and *not*
128+
your clone of the master `gh-pages` branch.
129+
To manage changes, we follow [GitHub flow][github-flow]. In brief:
130+
131+
1. Fork the repository to your GitHub profile and create a clone on your desktop.
132+
2. Create a new branch in your desktop copy of this repository for each significant
133+
change being made.
134+
3. Make revisions as required.
135+
4. Stage all changed files and commit them within the appropriate branch.
136+
5. Push any new branches to your forked copy of this repository on GitHub.
137+
6. Submit a pull request from that branch to the master repository.
138+
7. If you receive feedback, make changes using your desktop copy of the repository and
139+
push to your branch on GitHub. The pull request will update automatically.
140+
8. Repeat as needed.
141+
142+
Each lesson has two maintainers who review issues and pull requests or encourage others to do so.
143+
The maintainers are community volunteers and have final say over what gets merged into the lesson.
148144
149145
## Other Resources
150146
151147
General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
152148
happens on the [discussion mailing list][discuss-list],
153149
which everyone is welcome to join.
154-
You can also [reach us by email][email].
150+
You can also [reach us by email][contact].
155151
156-
[email]: mailto:[email protected]
152+
[contact]: mailto:[email protected]
157153
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
158154
[dc-lessons]: http://datacarpentry.org/lessons/
159155
[dc-site]: http://datacarpentry.org/
@@ -162,8 +158,7 @@
162158
[github-flow]: https://guides.github.com/introduction/flow/
163159
[github-join]: https://github.com/join
164160
[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/
161+
[issues]: https://guides.github.com/features/issues/
167162
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
168163
[swc-lessons]: http://software-carpentry.org/lessons/
169164
[swc-site]: http://software-carpentry.org/

0 commit comments

Comments
 (0)