Skip to content

Commit 7058af9

Browse files
tkphdtkphd
authored
Merge pull request #34 from tkphd/issue33-wrap_lines_at_79_characters
wrap lines at 79 characters
2 parents d8e1e20 + a06ca4c commit 7058af9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+1474
-1081
lines changed

‎.github/CODEOWNERS

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# This file lists the contributors responsible for the
2+
# repository content. They will also be automatically
3+
# asked to review any pull request made in this repository.
4+
5+
# Each line is a file pattern followed by one or more owners.
6+
# The sequence matters: later patterns take precedence.
7+
8+
# FILES OWNERS
9+
* @tkphd

‎.github/workflows/test_and_build.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Check lesson and build for all configs
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- gh-pages
8+
9+
jobs:
10+
spellcheck:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- name: Set up Python
15+
uses: actions/setup-python@v2
16+
with:
17+
python-version: 3.7
18+
- name: Install codespell
19+
run: |
20+
pip3 install codespell
21+
- name: Check spelling
22+
run: |
23+
codespell --skip="assets,*.svg,bin" --quiet-level=2 -L "rouge,dropse,namd,hist"
24+
25+
check_lesson_and_build_default:
26+
runs-on: ubuntu-latest
27+
steps:
28+
- uses: actions/checkout@v2
29+
- uses: actions/setup-ruby@v1
30+
with:
31+
ruby-version: '2.7'
32+
- name: Install basic requirements
33+
run: |
34+
# Need this library for nokogiri
35+
sudo apt-get install libxslt1-dev
36+
gem install bundler json kramdown kramdown-parser-gfm
37+
bundle config set path '.vendor/bundle'
38+
bundle config build.nokogiri --use-system-libraries
39+
bundle install
40+
- name: "Lint episode markdown"
41+
run: |
42+
find _episodes -name \*.md -exec bundle exec mdl -r MD001,MD003,MD005,MD006,MD007,MD008,MD009,MD010,MD011,MD012,MD015,MD016,MD017,MD018,MD019,MD020,MD021,MD022,MD023,MD025,MD035,MD036,MD037,MD038,MD039,MD046 {} \;
43+
- name: "Check lesson for warnings"
44+
run: |
45+
make lesson-check-all
46+
- name: "Check lesson for errors"
47+
run: |
48+
make lesson-check
49+
- name: "Check build"
50+
run: |
51+
make --always-make site

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,5 @@ files/*.fastq
1212
files/*.tsv
1313
Gemfile.lock
1414
scratch/
15+
.bundle
1516
.vendor

‎.travis.yml

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎AUTHORS

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
FIXME: list authors' names and email addresses.
1+
HPC Python is written and maintained by the members of
2+
[HPC Carpentry](https://github.com/hpc-carpentry).

‎CONTRIBUTING.md

Lines changed: 97 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -1,163 +1,133 @@
1-
# Contributing - HPC Carpentry
1+
# Contributing
22

3-
**This lesson is currently under active development by the HPC Carpentry team.**
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.
47

5-
Although this is intended to be an open lesson that follows the general
6-
Software and Data Carpentry contribution guidelines,
7-
we are currently focusing on delivering our initial lesson pass.
8+
## Contributor Agreement
89

9-
Although we appreciate external input,
10-
contributions and input from the wider community will be reviewed only once initial lesson generation is complete.
11-
(We want this lesson as much as you do!)
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).
1216

13-
## General contribution guidelines
17+
## How to Contribute
1418

15-
[Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects,
16-
and we welcome contributions of all kinds:
17-
new lessons,
18-
fixes to existing material,
19-
bug reports,
20-
and reviews of proposed changes are all welcome.
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.
2122

22-
## Contributor Agreement
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-
By contributing,
25-
you agree that we may redistribute your work under [our license](LICENSE.md).
26-
In exchange,
27-
we will address your issues and/or assess your change proposal as promptly as we can,
28-
and help you become a member of our community.
29-
Everyone involved in [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
30-
agrees to abide by our [code of conduct](CONDUCT.md).
27+
1. 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.
3131

32-
## How to Contribute
33-
34-
The easiest way to get started is to file an issue
35-
to tell us about a spelling mistake,
36-
some awkward wording,
37-
or a factual error.
38-
This is a good way to introduce yourself
39-
and to meet some of our community members.
40-
41-
1. If you do not have a [GitHub][github] account,
42-
you can [send us comments by email][contact].
43-
However,
44-
we will be able to respond more quickly if you use one of the other methods described below.
45-
46-
2. If you have a [GitHub][github] account,
47-
or are willing to [create one][github-join],
48-
but do not know how to use Git,
49-
you can report problems or suggest improvements by [creating an issue][issues].
50-
This allows us to assign the item to someone
51-
and to respond to it in a threaded discussion.
52-
53-
3. If you are comfortable with Git,
54-
and would like to add or change material,
55-
you can submit a pull request (PR).
56-
Instructions for doing this are [included below](#using-github).
32+
1. 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).
5735

5836
## Where to Contribute
5937

60-
1. If you wish to change this lesson,
61-
please work in <https://github.com/swcarpentry/FIXME>,
62-
which 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/carpentries-incubator/hpc-intro>, which can be viewed at
40+
<https://carpentries-incubator.github.io/hpc-intro>.
6341

64-
2. If you wish to change the example lesson,
65-
please work in <https://github.com/swcarpentry/lesson-example>,
66-
which documents the format of our lessons
67-
and can be viewed at <https://swcarpentry.github.io/lesson-example>.
42+
1. 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>.
6846

69-
3. If you wish to change the template used for workshop websites,
70-
please work in <https://github.com/swcarpentry/workshop-template>.
71-
The home page of that repository explains how to set up workshop websites,
72-
while the extra pages in <https://swcarpentry.github.io/workshop-template>
73-
provide more background on our design choices.
47+
1. 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.
7452

75-
4. If you wish to change CSS style files, tools,
76-
or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
77-
please work in <https://github.com/swcarpentry/styles>.
53+
1. 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>.
7856

7957
## What to Contribute
8058

81-
There are many ways to contribute,
82-
from writing new exercises and improving existing ones
83-
to updating or filling in the documentation
84-
and and submitting [bug reports][issues]
85-
about things that don't work, aren't clear, or are missing.
86-
If you are looking for ideas,
87-
please see [the list of issues for this repository][issues],
88-
or the issues for [Data Carpentry][dc-issues]
89-
and [Software Carpentry][swc-issues] projects.
90-
91-
Comments on issues and reviews of pull requests are just as welcome:
92-
we are smarter together than we are on our own.
93-
Reviews from novices and newcomers are particularly valuable:
94-
it's easy for people who have been using these lessons for a while
95-
to forget how impenetrable some of this material can be,
96-
so fresh eyes are always welcome.
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.
65+
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.
9771

9872
## What *Not* to Contribute
9973

100-
Our lessons already contain more material than we can cover in a typical workshop,
101-
so we are usually *not* looking for more concepts or tools to add to them.
102-
As a rule,
103-
if you want to introduce a new idea,
104-
you must (a) estimate how long it will take to teach
105-
and (b) explain what you would take out to make room for it.
106-
The first encourages contributors to be honest about requirements;
107-
the second, 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.
10880

109-
We are also not looking for exercises or other material that only run on one platform.
110-
Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users;
111-
in order to be usable,
112-
our lessons 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.
11385

11486
## Using GitHub
11587

116-
If you choose to contribute via GitHub,
117-
you may want to look at
118-
[How to Contribute to an Open Source Project on GitHub][how-contribute].
119-
In brief:
120-
121-
1. The published copy of the lesson is in the `gh-pages` branch of the repository
122-
(so that GitHub will regenerate it automatically).
123-
Please create all branches from that,
124-
and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch
125-
before starting work.
126-
Please do *not* work directly in your `gh-pages` branch,
127-
since that will make it difficult for you to work on other contributions.
128-
129-
2. We use [GitHub flow][github-flow] to manage changes:
130-
1. Create a new branch in your desktop copy of this repository for each significant change.
131-
2. Commit the change in that branch.
132-
3. Push that branch to your fork of this repository on GitHub.
133-
4. Submit a pull request from that branch to the [master repository][repo].
134-
5. If you receive feedback,
135-
make changes on your desktop and push to your branch on GitHub:
136-
the pull request will update automatically.
137-
138-
Each lesson has two maintainers who review issues and pull requests
139-
or encourage others to do so.
140-
The maintainers are community volunteers,
141-
and have final say over what gets merged into the lesson.
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+
1. 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+
1. Navigate to the file(s) you wish to change within the new branches and make
99+
revisions as required.
100+
1. Commit all changed files within the appropriate branches.
101+
1. Create individual pull requests from each of your changed branches to the
102+
`gh-pages` branch within the originating repository.
103+
1. If you receive feedback, make changes using your issue-specific branches of
104+
the forked repository and the pull requests will update automatically.
105+
1. Repeat as needed until all feedback has been addressed.
106+
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.
142113

143114
## Other Resources
144115

145-
General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
146-
happens on the [discussion mailing list][discuss-list],
147-
which everyone is welcome to join.
148-
You can also [reach us by email][contact].
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].
149119

150-
[contact]: mailto:[email protected]
120+
[email]: mailto:[email protected]
151121
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
152122
[dc-lessons]: http://datacarpentry.org/lessons/
153123
[dc-site]: http://datacarpentry.org/
154124
[discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
155-
[github]: http://github.com
125+
[github]: https://github.com
156126
[github-flow]: https://guides.github.com/introduction/flow/
157127
[github-join]: https://github.com/join
158128
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
159-
[issues]: https://github.com/swcarpentry/FIXME/issues/
160-
[repo]: https://github.com/swcarpentry/FIXME/
129+
[issues]: https://guides.github.com/features/issues/
161130
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
162-
[swc-lessons]: http://software-carpentry.org/lessons/
163-
[swc-site]: http://software-carpentry.org/
131+
[swc-lessons]: https://software-carpentry.org/lessons/
132+
[swc-site]: https://software-carpentry.org/
133+

‎Gemfile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,4 @@
11
source "https://rubygems.org"
22
gem "github-pages", group: :jekyll_plugins
3+
gem "kramdown-parser-gfm"
4+
gem "mdl"

0 commit comments

Comments
 (0)