Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

Commit 3be6b29

Browse files
committed
hard wrap at 79 characters
GitHub's diff view for code comparison soft-wraps at 80 chars. With the former 100-char line limit, this made for cluttered views. This change should help to focus review on specific changed lines.
1 parent ecc9f39 commit 3be6b29

15 files changed

+1027
-770
lines changed

CONTRIBUTING.md

Lines changed: 87 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,107 +1,123 @@
11
# Contributing
22

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.
67

78
## Contributor Agreement
89

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).
1316

1417
## How to Contribute
1518

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.
1922

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.
2326

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.
2831

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).
3135

3236
## Where to Contribute
3337

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>.
3641

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>.
4046

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.
4552

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>.
4856

4957
## What to Contribute
5058

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.
5665

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.
6171

6272
## What *Not* to Contribute
6373

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.
6980

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.
7385

7486
## Using GitHub
7587

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
89102
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.
93106

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.
99113

100114
## Other Resources
101115

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 -->
105121

106122
[email]: mailto:admin@software-carpentry.org
107123
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry

README.md

Lines changed: 55 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,81 @@
11
# Introduction to using the shell in a High-Performance Computing context
22

3-
This lesson provides an introduction to the bash shell aimed at researchers who will be using
4-
the command line to use remote, high-performance computing (HPC) systems. The material is also
5-
suitable for teaching the use of the shell for any remote, advanced computing resources.
3+
This lesson provides an introduction to the bash shell aimed at researchers who
4+
will be using the command line to use remote, high-performance computing (HPC)
5+
systems. The material is also suitable for teaching the use of the shell for
6+
any remote, advanced computing resources.
67

78

89
## Using this material
910

10-
1. Follow the instructions found in the [Software Carpentry example lesson source](https://github.com/carpentries/lesson-example/)
11-
to create a repository for your lesson.
12-
2. Edit [_config.yml](_config.yml) to modify the configuration options at the bottom for the
13-
remote host you will be using. These options set such things as the address of the host
14-
to login to and the ID that is used to incorporate host-specific code snippets (see below).
11+
1. Follow the instructions found in the [Software Carpentry example lesson
12+
source](https://github.com/carpentries/lesson-example/) to create a
13+
repository for your lesson.
14+
2. Edit [_config.yml](_config.yml) to modify the configuration options at the
15+
bottom for the remote host you will be using. These options set such things
16+
as the address of the host to login to and the ID that is used to
17+
incorporate host-specific code snippets (see below).
1518
3. Create the required host-specific code snippets in subdirectories in
16-
[_includes/snippets](_includes/snippets). These snippets provide inputs and outputs that
17-
are host-specific and that are included automatically based on the configuration in the
18-
`_config.yml` file.
19-
1. Code snippets are in files named `snippet_name.host_id` and are included automatically
20-
when the lesson is built. For example, if the `snippet_name` was `login_output` and the
21-
`host_id` was `ComputeCanada_Graham`, then the snippet file would be called
22-
`login_output.ComputeCanada_Graham`.
23-
2. Code snippets are placed in subdirectories that are named according to the episode they
24-
appear in. For example, if the snippet is for episode 01, then it will be in a
25-
subdirectory called `01`.
19+
[_includes/snippets](_includes/snippets). These snippets provide inputs and
20+
outputs that are host-specific and that are included automatically based on
21+
the configuration in the `_config.yml` file.
22+
1. Code snippets are in files named `snippet_name.host_id` and are included
23+
automatically when the lesson is built. For example, if the
24+
`snippet_name` was `login_output` and the `host_id` was
25+
`ComputeCanada_Graham`, then the snippet file would be called
26+
`login_output.ComputeCanada_Graham`.
27+
2. Code snippets are placed in subdirectories that are named according to
28+
the episode they appear in. For example, if the snippet is for episode
29+
01, then it will be in a subdirectory called `01`.
2630

2731

2832
## Lesson writing instructions
2933

30-
This is a fast overview of the Software Carpentry lesson template. This won't cover lesson style or
31-
formatting (address that during review?).
34+
This is a fast overview of the Software Carpentry lesson template. This won't
35+
cover lesson style or formatting (address that during review?).
3236

33-
For a full guide to the lesson template, see the
34-
[Software Carpentry example lesson](http://swcarpentry.github.io/lesson-example/).
37+
For a full guide to the lesson template, see the [Software Carpentry example
38+
lesson](http://swcarpentry.github.io/lesson-example/).
3539

3640
### Lesson structure
3741

38-
Software Carpentry lessons are generally episodic, with one clear concept for each episode
39-
([example](http://swcarpentry.github.io/r-novice-gapminder/)).
40-
41-
An episode is a markdown file that lives under the `_episodes` folder. Here is a link to a
42-
[markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) with most
43-
markdown syntax. Additionally, the Software Carpentry lesson template uses several extra bits of
44-
formatting- see here for a [full guide](http://swcarpentry.github.io/lesson-example/04-formatting/).
45-
The most significant change is the addition of a YAML header that adds metadata (key questions,
46-
lesson teaching times, etc.) and special syntax for code blocks, exercises, and the like.
47-
48-
Episode names should be prefixed with a number of their section plus the number of their episode
49-
within that section. This is important because the Software Carpentry lesson template will auto-post
50-
our lessons in the order that they would sort in. As long as your lesson sorts into the correct
51-
order, it will appear in the correct order on the website.
42+
Software Carpentry lessons are generally episodic, with one clear concept for
43+
each episode ([example](http://swcarpentry.github.io/r-novice-gapminder/)).
44+
45+
An episode is a markdown file that lives under the `_episodes` folder. Here is
46+
a link to a [markdown
47+
cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)
48+
with most markdown syntax. Additionally, the Software Carpentry lesson template
49+
uses several extra bits of formatting- see here for a [full
50+
guide](http://swcarpentry.github.io/lesson-example/04-formatting/). The most
51+
significant change is the addition of a YAML header that adds metadata (key
52+
questions, lesson teaching times, etc.) and special syntax for code blocks,
53+
exercises, and the like.
54+
55+
Episode names should be prefixed with a number of their section plus the number
56+
of their episode within that section. This is important because the Software
57+
Carpentry lesson template will auto-post our lessons in the order that they
58+
would sort in. As long as your lesson sorts into the correct order, it will
59+
appear in the correct order on the website.
5260

5361
### Publishing changes to Github + the Github pages website
5462

55-
The lesson website is viewable at
56-
[https://hpc-carpentry.github.io/hpc-shell/](https://hpc-carpentry.github.io/hpc-shell/)
63+
The lesson website is viewable at <https://hpc-carpentry.github.io/hpc-shell/>.
5764

58-
The lesson website itself is auto-generated from the `gh-pages` branch of this repository. Github
59-
pages will rebuild the website as soon as you push to the Github `gh-pages` branch. Because of this
60-
`gh-pages` is considered the "master" branch.
65+
The lesson website itself is auto-generated from the `gh-pages` branch of this
66+
repository. Github pages will rebuild the website as soon as you push to the
67+
Github `gh-pages` branch. Because of this `gh-pages` is considered the "master"
68+
branch.
6169

6270
### Previewing changes locally
6371

64-
Obviously having to push to Github every time you want to view your changes to the website isn't
65-
very convenient. To preview the lesson locally, run `make serve`. You can then view the website at
66-
`localhost:4000` in your browser. Pages will be automatically regenerated every time you write to
67-
them.
72+
Obviously having to push to Github every time you want to view your changes to
73+
the website isn't very convenient. To preview the lesson locally, run `make
74+
serve`. You can then view the website at `localhost:4000` in your browser.
75+
Pages will be automatically regenerated every time you write to them.
6876

69-
Note that the autogenerated website lives under the `_site` directory (and doesn't get pushed to
70-
Github).
77+
Note that the autogenerated website lives under the `_site` directory (and
78+
doesn't get pushed to Github).
7179

7280
This process requires Ruby, Make, and Jekyll. You can find setup instructions
7381
[here](http://swcarpentry.github.io/lesson-example/setup/).

0 commit comments

Comments
 (0)