-
-
Notifications
You must be signed in to change notification settings - Fork 290
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
mfisher87
wants to merge
6
commits into
carpentries:main
Choose a base branch
from
mfisher87:minor-fixes
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e164f74
Bold key words in 2x2 paradigm paragraph
mfisher87 a93b7b9
Clarify overloaded "they"
mfisher87 b39fae6
Update terminology and fix copy-paste(?) mistakes
mfisher87 3958fc6
Update contributing instructions to fix incorrect branch
mfisher87 851077e
Update contributing instructions to fix incorrect branch
mfisher87 51c033a
Update contributing instructions to fix incorrect branch
mfisher87 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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), | ||
|
@@ -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. | ||
|
||
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. | ||
|
@@ -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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @karenword :)