Skip to content
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.

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

Miscellaneous minor wording / emphasis / link changes #1627

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ and to meet some of our community members.
## Where to Contribute

1. If you wish to change this lesson,
please work in [https://github.com/swcarpentry/shell-novice](https://github.com/swcarpentry/shell-novice),
which can be viewed at [https://swcarpentry.github.io/shell-novice](https://swcarpentry.github.io/shell-novice).
please work in [https://github.com/carpentries/instructor-training](https://github.com/carpentries/instructor-training),
which can be viewed at [https://carpentries.github.io/instructor-training](https://carpentries.github.io/instructor-training).

2. If you wish to change the example lesson,
please work in [https://github.com/carpentries/lesson-example](https://github.com/carpentries/lesson-example),
Expand Down Expand Up @@ -106,20 +106,20 @@ you may want to look at
[How to Contribute to an Open Source Project on GitHub][how-contribute].
In brief:

1. The published copy of the lesson is in the `gh-pages` branch of the repository
1. The published copy of the lesson is in the `main` branch of the repository
(so that GitHub will regenerate it automatically).
Please create all branches from that,
and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch
and merge the [upstream repository][repo]'s `main` branch into your `main` branch
before starting work.
Please do *not* work directly in your `gh-pages` branch,
Please do *not* work directly in your `main` branch,
since that will make it difficult for you to work on other contributions.
Copy link
Author

@mfisher87 mfisher87 Nov 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This instruction about creating branches from gh-pages doesn't seem to reflect the reality of how this repo is being used, so I followed the pattern it looked like others were following.

https://github.com/carpentries/sandpaper/raw/main/vignettes/articles/img/branch-flow.svg

Is this a vestigial instruction? gh-pages seems to only be updated by GitHub Actions in the way I'm used to.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @mfisher87 ! I think the most functional change is to update gh-pages to main in all cases (even if gh-pages is technically the published branch). Pinging @tobyhodges to verify.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @karenword :)


2. We use [GitHub flow][github-flow] to manage changes:

1. Create a new branch in your desktop copy of this repository for each significant change.
2. Commit the change in that branch.
3. Push that branch to your fork of this repository on GitHub.
4. Submit a pull request from that branch to the [master repository][repo].
4. Submit a pull request from that branch to the [upstream repository][repo].
5. If you receive feedback,
make changes on your desktop and push to your branch on GitHub:
the pull request will update automatically.
Expand All @@ -141,11 +141,11 @@ You can also [reach us by email][contact].
[github]: https://github.com
[contact]: mailto:[email protected]
[github-join]: https://github.com/join
[issues]: https://github.com/swcarpentry/shell-novice/issues/
[issues]: https://github.com/carpentries/instructor-training/issues/
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
[repo]: https://github.com/swcarpentry/shell-novice/
[repo]: https://github.com/carpentries/instructor-training/
[github-flow]: https://guides.github.com/introduction/flow/
[discuss-list]: https://lists.software-carpentry.org/listinfo/discuss

Expand Down
2 changes: 1 addition & 1 deletion episodes/04-expertise.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ This does *not* mean that they are not important,
or are not worth learning,
but if our aim is to convince people that they can learn this stuff,
and that doing so will help them do more research faster,
they are less compelling than things like automating repetitive tasks.
computer science concepts are less compelling than things like automating repetitive tasks.


::::::::::::::::::::::::::::::::::::::::::::::::::
Expand Down
4 changes: 2 additions & 2 deletions episodes/11-practice-teaching.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,9 @@ Sometimes it can be hard to receive feedback, especially negative feedback.
![](fig/deathbulge-jerk.jpg "Comic from http://www.deathbulge.com/comics/155"){alt='A three panel comic. In the first panel, a smiling figure is surrounded by speech bubbles with mostly positive feedback. In the second panel, the figure is eating dinner. All of the previous speech bubbles appear faded out, except the one negative bubble. The third panel shows the figure in bed, with an unhappy face, with the one piece of negative feedback lingering after all others have faded.'}

Feedback is most effective when the people involved
share ground rules and expectations. In Carpentries teaching, we use the 2x2
share ground rules and expectations. In Carpentries teaching, we use the **2x2**
paradigm for feedback. Each person giving feedback is expected to provide at least one
piece of negative and one piece of positive feedback each for content and delivery. This
piece of **negative** and one piece of **positive** feedback each for **content** and **delivery**. This
helps overcome two common tendencies when giving feedback on teaching: to focus on the content
(even though delivery is at least as important) and to either provide only negative or
only positive feedback.
Expand Down