Miscellaneous minor wording / emphasis / link changes #1627
Conversation
After reading this paragraph the first time, I wanted to skim back for the 4 elements of the rubric, and it took me longer than I would have liked to find them, which was a tiny bit distracting. I think bolding helps!
The previous use of "they" refers to "people", so I feel this use of "they" needs to be clarified. I got a bit stuck my first time reading ths sentence :)
🆗 Pre-flight checks passed 😃This pull request has been checked and contains no modified workflow files, spoofing, or invalid commits. It should be safe to Approve and Run the workflows that need maintainer approval. |
mfisher87
changed the title
| @@ -109,7 +109,7 @@ In brief: | |||
| 1. The published copy of the lesson is in the `gh-pages` 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 `gh-pages` branch into your `gh-pages` branch | |||
| before starting work. | |||
| Please do *not* work directly in your `gh-pages` branch, | |||
| since that will make it difficult for you to work on other contributions. | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
| @@ -109,7 +109,7 @@ In brief: | |||
| 1. The published copy of the lesson is in the `gh-pages` 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 `gh-pages` branch into your `gh-pages` branch | |||
| before starting work. | |||
| Please do *not* work directly in your `gh-pages` branch, | |||
| since that will make it difficult for you to work on other contributions. | |||
There was a problem hiding this comment.
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.
Co-authored-by: Karen Word <[email protected]>
Co-authored-by: Karen Word <[email protected]>
Co-authored-by: Karen Word <[email protected]>
|
@tobyhodges is this still relevant? If so, can you review and approve or request changes? Thanks. |
If this pull request addresses an open issue on the repository, please add 'Closes #NN' below, where NN is the issue number.
Please briefly summarise the changes made in the pull request, and the reason(s) for making these changes.
I completed instructor training recently (it was awesome) and took some notes where I got briefly "stuck" and distracted reading the curriculum. More rationale in commit messages about the specific changes :)
As I was working on this I also noticed some links in
CONTRIBUTING.mddidn't behave as expected, and looking atCONTRIBUTING.mdin other lesson repos, I think the preferred terminology changed from "master repository" to "upstream repository", so I got that while I was in there too.Thanks all!
If any relevant discussions have taken place elsewhere, please provide links to these.
For more guidance on how to contribute changes to a Carpentries project, please review the Contributing Guide and Code of Conduct.
Please keep in mind that lesson Maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact The Carpentries Team at [email protected].