Skip to content

Commit 55b723a

Browse files
authored
Made requested revisions to lesson_initialize
Changed the keyword for emailing from 'contact' to 'email' per carpentries/styles#178 and changed the description for how to use GitHub to reflect usage of the web interface.
1 parent 8404c00 commit 55b723a

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

bin/lesson_initialize.py

Lines changed: 15 additions & 15 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][contact].
48+
you can [send us comments by email][email].
4949
However,
5050
we will be able to respond more quickly if you use one of the other methods described below.
5151
@@ -126,18 +126,18 @@
126126
and create your own revision-specific branch(es) from there.
127127
Please only work on your newly-created branch(es) and *not*
128128
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.
129+
To manage changes, we follow [GitHub flow][github-flow]. Using the web interface:
130+
131+
1. Fork the master repository to your GitHub profile.
132+
2. Within your version of the forked repository, move to the `gh-pages` branch and
133+
create a new branch for each significant change being made.
134+
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
135+
4. Commit all changed files within the appropriate branches.
136+
5. Create individual pull requests from each of your changed branches
137+
to the `gh-pages` branch within the master repository.
138+
6. If you receive feedback, make changes using your issue-specific branches of the forked
139+
repository and the pull requests will update automatically.
140+
7. Repeat as needed until all feedback has been addressed.
141141
142142
Each lesson has two maintainers who review issues and pull requests or encourage others to do so.
143143
The maintainers are community volunteers and have final say over what gets merged into the lesson.
@@ -147,9 +147,9 @@
147147
General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
148148
happens on the [discussion mailing list][discuss-list],
149149
which everyone is welcome to join.
150-
You can also [reach us by email][contact].
150+
You can also [reach us by email][email].
151151
152-
[contact]: mailto:[email protected]
152+
[email]: mailto:[email protected]
153153
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
154154
[dc-lessons]: http://datacarpentry.org/lessons/
155155
[dc-site]: http://datacarpentry.org/

0 commit comments

Comments
 (0)