Skip to content

incorporate remaining changes from issue #1 #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jlcohoon merged 2 commits into from
Oct 27, 2025
Merged

incorporate remaining changes from issue #1 #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90b9542
incorporate changes from issue-1
jennyknuth Oct 10, 2025
d24a5b0
capitalization
jennyknuth Oct 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
88 changes: 36 additions & 52 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Thanks go to current and past contributors:
- Eriol Fox (content development, feedback)
- Mary Goldman (content development, feedback, presentation)
- Toby Hodges (consulting on format and approach)
- Jenny Knuth (content, feedback)
- Anh Le (content development, feedback)
- Cody O’Donnell (feedback)
- Drew Paine (feedback)
Expand All @@ -29,67 +30,50 @@ The project is generously funded by the Alfred P. Sloan Foundation, Liz Vu & Jos

### Contributor Agreement

By contributing, you agree that we may redistribute your work under [our CCBY
license](LICENSE.md). In exchange, we will address your issues and/or assess
your contribution as promptly as we can, and help you become a member of our
community.

This lesson was developed in partnership with The Carpentries and is part of
their [incubator program](https://carpentries-incubator.org/). Everyone involved in The Carpentries agrees to abide by
their [code of conduct](CODE_OF_CONDUCT.md).

### What and how to Contribute
There are many ways to contribute and we hope you'll get involved:

If you have an idea for substantially modifying the lesson content, the first thing you
should do is to open an [issue](repo-issues) describing that idea. Lesson episodes were written with specific goals
and strategies in mind. Discussing your change via an issue allows us to ensure your contribution aligns
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
have a strong positive impact. This also means you can contribute ideas without
having to write lesson content yourself (if you don't want to). As a rule, if you want to
introduce a new idea or exercise to the lesson, you must estimate how
long it will take to teach and 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.

If you see a small fix that is needed (e.g., addressing a typo or broken link), go ahead
and make the fix yourself and then open a pull request. If you don't know how to do that, you can
open an [issue][repo-issues] or [email the maintainers][contact] instead.

Comments on issues and reviews of pull requests are just as welcome as new issues: 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. That means that if you see an open issue or PR, you should
feel free to comment on it.

*Note:* If you wish to change the template used for the lesson website, please refer
to [The Workbench documentation][template-doc]. The maintainers of this lesson are not
responsible for the website template, only the contents.
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.

This lesson was developed in partnership with The Carpentries and is part of
their [incubator program](https://carpentries-incubator.org/). Everyone involved in The Carpentries agrees to abide by their [code of conduct](CODE_OF_CONDUCT.md).

### What and How to Contribute
There are many ways to contribute, and we’d love for you to get involved:

#### Substantial changes
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.

When suggesting new exercises or material, please estimate how long they would take to teach.
Also let us know what you would remove to make space. This helps us keep lessons focused and realistic.

#### Small fixes
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.

#### Comments and reviews
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.

#### Website template
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.

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

#### Contributors
Contributors are people who have given advice or written content that was incorporated into this lesson.
People who have presented this tutorial are also considered contributors. You can become a contributor
by opening an issue or pull request. When your changes are integrated your name will be added to the
alphabetical list of contributors above.
Contributors are people who have given advice or written content that was incorporated into this lesson.
People who have presented this lesson are also considered contributors. You can become a contributor
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.

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

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

#### Creators
Creators are the original set of people who developed the content for this lesson and are the authors listed in
Creators are the original set of people who developed the content for this lesson and are the authors listed in
the [citation](CITATION.cff) for this lesson:

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

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