Skip to content

Commit 11da4fd

Browse files
authored
Merge pull request #6 from jennyknuth/issues-1
incorporate remaining changes from issue #1
2 parents 5dd62c7 + d24a5b0 commit 11da4fd

1 file changed

Lines changed: 36 additions & 52 deletions

File tree

CONTRIBUTING.md

Lines changed: 36 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Thanks go to current and past contributors:
1212
- Eriol Fox (content development, feedback)
1313
- Mary Goldman (content development, feedback, presentation)
1414
- Toby Hodges (consulting on format and approach)
15+
- Jenny Knuth (content, feedback)
1516
- Anh Le (content development, feedback)
1617
- Cody O’Donnell (feedback)
1718
- Drew Paine (feedback)
@@ -29,67 +30,50 @@ The project is generously funded by the Alfred P. Sloan Foundation, Liz Vu & Jos
2930

3031
### Contributor Agreement
3132

32-
By contributing, you agree that we may redistribute your work under [our CCBY
33-
license](LICENSE.md). In exchange, we will address your issues and/or assess
34-
your contribution as promptly as we can, and help you become a member of our
35-
community.
36-
37-
This lesson was developed in partnership with The Carpentries and is part of
38-
their [incubator program](https://carpentries-incubator.org/). Everyone involved in The Carpentries agrees to abide by
39-
their [code of conduct](CODE_OF_CONDUCT.md).
40-
41-
### What and how to Contribute
42-
There are many ways to contribute and we hope you'll get involved:
43-
44-
If you have an idea for substantially modifying the lesson content, the first thing you
45-
should do is to open an [issue](repo-issues) describing that idea. Lesson episodes were written with specific goals
46-
and strategies in mind. Discussing your change via an issue allows us to ensure your contribution aligns
47-
with the lesson goals. This isn't meant as a way to filter out contributions, it's a way to make sure your proposed changes
48-
have a strong positive impact. This also means you can contribute ideas without
49-
having to write lesson content yourself (if you don't want to). As a rule, if you want to
50-
introduce a new idea or exercise to the lesson, you must estimate how
51-
long it will take to teach and explain what you would take out to make room
52-
for it. The first encourages contributors to be honest about requirements; the
53-
second, to think hard about priorities.
54-
55-
If you see a small fix that is needed (e.g., addressing a typo or broken link), go ahead
56-
and make the fix yourself and then open a pull request. If you don't know how to do that, you can
57-
open an [issue][repo-issues] or [email the maintainers][contact] instead.
58-
59-
Comments on issues and reviews of pull requests are just as welcome as new issues: we are
60-
smarter together than we are on our own. Reviews from novices and newcomers
61-
are particularly valuable: it's easy for people who have been using these
62-
lessons for a while to forget how impenetrable some of this material can be, so
63-
fresh eyes are always welcome. That means that if you see an open issue or PR, you should
64-
feel free to comment on it.
65-
66-
*Note:* If you wish to change the template used for the lesson website, please refer
67-
to [The Workbench documentation][template-doc]. The maintainers of this lesson are not
68-
responsible for the website template, only the contents.
33+
Our lessons are community-driven. By submitting your work, you agree to license it under the Creative Commons Attribution (CC BY 4.0) [license](LICENSE.md). You retain copyright, but grant The Carpentries the right to use, modify, and redistribute your contribution under this license. In return, we commit to reviewing contributions promptly, providing constructive feedback, and supporting your participation in our community. All contributions must follow The Carpentries’ [Code of Conduct](CODE_OF_CONDUCT.md), which ensures a respectful and inclusive environment.
34+
35+
This lesson was developed in partnership with The Carpentries and is part of
36+
their [incubator program](https://carpentries-incubator.org/). Everyone involved in The Carpentries agrees to abide by their [code of conduct](CODE_OF_CONDUCT.md).
37+
38+
### What and How to Contribute
39+
There are many ways to contribute, and we’d love for you to get involved:
40+
41+
#### Substantial changes
42+
If you have an idea for a bigger change (like adding or re-working lesson content), please start by opening an [issue](repo-issues). This gives us a chance to discuss how your idea fits with the lesson goals before you spend time writing. You don’t need to write the lesson yourself if you don’t want to. Sharing the idea is already valuable.
43+
44+
When suggesting new exercises or material, please estimate how long they would take to teach.
45+
Also let us know what you would remove to make space. This helps us keep lessons focused and realistic.
46+
47+
#### Small fixes
48+
If you find typos, broken links, or other quick improvements, go ahead and open a pull request with the fix. If you’re not sure how, just open an [issue][repo-issues] or [email the maintainers][contact] and we’ll help.
49+
50+
#### Comments and reviews
51+
Feedback is as important as new content. Commenting on issues or reviewing pull requests helps improve lessons for everyone. Fresh eyes are especially useful—novices often notice what experienced users overlook.
52+
53+
#### Website template
54+
If you’d like to change the lesson website template itself, please see [The Carpentries Workbench][template-doc] documentation. Lesson maintainers handle content only, not the template.
6955

7056
### Roles and Recognition
71-
A formal governance structure for this lesson is still being established; the procedures
72-
for decision making and contributing may change. If you have thoughts on this,
73-
you can share them by [opening an issue][issues]. In the interim, we
57+
A formal governance structure for this lesson is still being established; the procedures
58+
for decision making and contributing may change. If you have thoughts on this,
59+
you can share them by [opening an issue][issues]. In the interim, we
7460
recognize three roles for people working on this project: contributors, maintainers, and creators.
7561

7662
#### Contributors
77-
Contributors are people who have given advice or written content that was incorporated into this lesson.
78-
People who have presented this tutorial are also considered contributors. You can become a contributor
79-
by opening an issue or pull request. When your changes are integrated your name will be added to the
80-
alphabetical list of contributors above.
63+
Contributors are people who have given advice or written content that was incorporated into this lesson.
64+
People who have presented this lesson are also considered contributors. You can become a contributor
65+
by opening an issue or pull request. When suggestions or changes are integrated, your name will be added to the alphabetical list of contributors above.
8166

8267
#### Maintainers
83-
Maintainers fill an important role within this lesson's and the broader STRUDEL community.
84-
Maintainers are contributors that have a formal responsibility keeping this lesson usable by the community.
85-
This involves reviewing and integrating contributions. If you reach out about this lesson
86-
or other STRUDEL projects via Github or email, it is likely you will get a response from one of our maintainers.
68+
Maintainers are contributors that have a formal responsibility keeping this lesson usable by the community.
69+
This involves reviewing and integrating contributions. If you reach out about this lesson
70+
or other STRUDEL projects via GitHub or email, it is likely you will get a response from one of our maintainers.
8771

88-
Presently, Hannah Cohoon of Lawrence Berkeley National Lab's STRUDEL project is the lesson's primary maintainer.
89-
If you would like to become a maintainer, [open an issue in this repo][issues] indicating as such.
72+
Presently, Hannah Cohoon of Lawrence Berkeley National Lab's [STRUDEL project](https://strudel.science/) is the lesson's primary maintainer.
73+
If you would like to become a maintainer, [open an issue in this repo][issues] indicating your interest.
9074

9175
#### Creators
92-
Creators are the original set of people who developed the content for this lesson and are the authors listed in
76+
Creators are the original set of people who developed the content for this lesson and are the authors listed in
9377
the [citation](CITATION.cff) for this lesson:
9478

9579
- Hannah Cohoon, LBNL
@@ -100,7 +84,7 @@ the [citation](CITATION.cff) for this lesson:
10084
- Anh Le, Superbloom Design
10185

10286
### The Carpentries
103-
This lesson on rapid usability testing was developed with the instruction and in
87+
This lesson on rapid usability testing was developed with the instruction and in
10488
partnership with [The Carpentries][cp-site]. The Carpentries ([Software Carpentry][swc-site], [Data
10589
Carpentry][dc-site], and [Library Carpentry][lc-site]) are open source
10690
projects, and welcome contributions of all kinds: new lessons, fixes to

0 commit comments

Comments
 (0)