Skip to content

Commit e30b3aa

Browse files
Merge pull request #255 from LibraryCarpentry/iss-253
Remove hard-wrapped lines
2 parents 3284ca1 + 4653bbb commit e30b3aa

8 files changed

Lines changed: 203 additions & 703 deletions

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -1,106 +1,57 @@
11
## Contributing
22

3-
[The Carpentries][cp-site] ([Software Carpentry][swc-site], [Data
4-
Carpentry][dc-site], and [Library Carpentry][lc-site]) are open source
5-
projects, and we welcome contributions of all kinds: new lessons, fixes to
6-
existing material, bug reports, and reviews of proposed changes are all
7-
welcome.
3+
[The Carpentries][cp-site] ([Software Carpentry][swc-site], [Data Carpentry][dc-site], and [Library Carpentry][lc-site]) are open source projects, and we welcome contributions of all kinds: new lessons, fixes to existing material, bug reports, and reviews of proposed changes are all welcome.
84

95
### Contributor Agreement
106

11-
By contributing, you agree that we may redistribute your work under [our
12-
license](LICENSE.md). In exchange, we will address your issues and/or assess
13-
your change proposal as promptly as we can, and help you become a member of our
14-
community. Everyone involved in [The Carpentries][cp-site] agrees to abide by
15-
our [code of conduct](CODE_OF_CONDUCT.md).
7+
By contributing, you agree that we may redistribute your work under [our license](LICENSE.md). In exchange, we will address your issues and/or assess your change proposal as promptly as we can, and help you become a member of our community. Everyone involved in [The Carpentries][cp-site] agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
168

179
### How to Contribute
1810

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.
11+
The easiest way to get started is to file an issue to tell us about a spelling mistake, some awkward wording, or a factual error. This is a good way to introduce yourself and to meet some of our community members.
2212

23-
1. If you do not have a [GitHub][github] account, you can [send us comments by
24-
email][contact]. However, we will be able to respond more quickly if you use
25-
one of the other methods described below.
13+
1. If you do not have a [GitHub][github] account, you can [send us comments by email][contact]. However, we will be able to respond more quickly if you use one of the other methods described below.
2614

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][repo-issues]. This allows us
30-
to assign the item to someone and to respond to it in a threaded discussion.
15+
2. If you have a [GitHub][github] account, or are willing to [create one][github-join], but do not know how to use Git, you can report problems or suggest improvements by [creating an issue][repo-issues]. This allows us to assign the item to someone and to respond to it in a threaded discussion.
3116

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). For inspiration about changes that need to
35-
be made, check out the [list of open issues][issues] across the Carpentries.
17+
3. If you are comfortable with Git, and would like to add or change material, you can submit a pull request (PR). Instructions for doing this are [included below](#using-github). For inspiration about changes that need to be made, check out the [list of open issues][issues] across the Carpentries.
3618

37-
Note: if you want to build the website locally, please refer to [The Workbench
38-
documentation][template-doc].
19+
Note: if you want to build the website locally, please refer to [The Workbench documentation][template-doc].
3920

4021
### Where to Contribute
4122

4223
1. If you wish to change this lesson, add issues and pull requests here.
43-
2. If you wish to change the template used for workshop websites, please refer
44-
to [The Workbench documentation][template-doc].
45-
24+
2. If you wish to change the template used for workshop websites, please refer to [The Workbench documentation][template-doc].
4625

4726
### What to Contribute
4827

49-
There are many ways to contribute, from writing new exercises and improving
50-
existing ones to updating or filling in the documentation and submitting [bug
51-
reports][issues] about things that do not work, are not clear, or are missing.
52-
If you are looking for ideas, please see [the list of issues for this
53-
repository][repo-issues], or the issues for [Data Carpentry][dc-issues],
54-
[Library Carpentry][lc-issues], and [Software Carpentry][swc-issues] projects.
28+
There are many ways to contribute, from writing new exercises and improving existing ones to updating or filling in the documentation and submitting [bug reports][issues] about things that do not work, are not clear, or are missing. If you are looking for ideas, please see [the list of issues for this repository][repo-issues], or the issues for [Data Carpentry][dc-issues], [Library Carpentry][lc-issues], and [Software Carpentry][swc-issues] projects.
5529

56-
Comments on issues and reviews of pull requests are just as welcome: we are
57-
smarter together than we are on our own. **Reviews from novices and newcomers
58-
are particularly valuable**: it's easy for people who have been using these
59-
lessons for a while to forget how impenetrable some of this material can be, so
60-
fresh eyes are always welcome.
30+
Comments on issues and reviews of pull requests are just as welcome: we are smarter together than we are on our own. **Reviews from novices and newcomers are particularly valuable**: it's easy for people who have been using these lessons for a while to forget how impenetrable some of this material can be, so fresh eyes are always welcome.
6131

6232
### What *Not* to Contribute
6333

64-
Our lessons already contain more material than we can cover in a typical
65-
workshop, so we are usually *not* looking for more concepts or tools to add to
66-
them. As a rule, if you want to introduce a new idea, you must (a) estimate how
67-
long it will take to teach and (b) explain what you would take out to make room
68-
for it. The first encourages contributors to be honest about requirements; the
69-
second, to think hard about priorities.
34+
Our lessons already contain more material than we can cover in a typical workshop, so we are usually *not* looking for more concepts or tools to add to them. As a rule, if you want to introduce a new idea, you must (a) estimate how long it will take to teach and (b) explain what you would take out to make room for it. The first encourages contributors to be honest about requirements; the second, to think hard about priorities.
7035

71-
We are also not looking for exercises or other material that only run on one
72-
platform. Our workshops typically contain a mixture of Windows, macOS, and
73-
Linux users; in order to be usable, our lessons must run equally well on all
74-
three.
36+
We are also not looking for exercises or other material that only run on one platform. Our workshops typically contain a mixture of Windows, macOS, and Linux users; in order to be usable, our lessons must run equally well on all three.
7537

7638
### Using GitHub
7739

78-
If you choose to contribute via GitHub, you may want to look at [How to
79-
Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we
80-
use [GitHub flow][github-flow] to manage changes:
40+
If you choose to contribute via GitHub, you may want to look at [How to Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we use [GitHub flow][github-flow] to manage changes:
8141

82-
1. Create a new branch in your desktop copy of this repository for each
83-
significant change.
42+
1. Create a new branch in your desktop copy of this repository for each significant change.
8443
2. Commit the change in that branch.
8544
3. Push that branch to your fork of this repository on GitHub.
8645
4. Submit a pull request from that branch to the [upstream repository][repo].
87-
5. If you receive feedback, make changes on your desktop and push to your
88-
branch on GitHub: the pull request will update automatically.
46+
5. If you receive feedback, make changes on your desktop and push to your branch on GitHub: the pull request will update automatically.
8947

9048
NB: The published copy of the lesson is usually in the `main` branch.
9149

92-
Each lesson has a team of maintainers who review issues and pull requests or
93-
encourage others to do so. The maintainers are community volunteers, and have
94-
final say over what gets merged into the lesson.
50+
Each lesson has a team of maintainers who review issues and pull requests or encourage others to do so. The maintainers are community volunteers, and have final say over what gets merged into the lesson.
9551

9652
### Other Resources
9753

98-
The Carpentries is a global organisation with volunteers and learners all over
99-
the world. We share values of inclusivity and a passion for sharing knowledge,
100-
teaching and learning. There are several ways to connect with The Carpentries
101-
community listed at <https://carpentries.org/connect/> including via social
102-
media, slack, newsletters, and email lists. You can also [reach us by
103-
email][contact].
54+
The Carpentries is a global organisation with volunteers and learners all over the world. We share values of inclusivity and a passion for sharing knowledge, teaching and learning. There are several ways to connect with The Carpentries community listed at <https://carpentries.org/connect/> including via social media, slack, newsletters, and email lists. You can also [reach us by email][contact].
10455

10556
[repo]: https://github.com/LibraryCarpentry/lc-shell/
10657
[repo-issues]: https://github.com/LibraryCarpentry/lc-shell/issues

0 commit comments

Comments
 (0)