[Feb 4 merge] Review GitHub lessons 0-3 #105
Open
Conversation
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
lwasser
changed the title
lwasser
commented
Jan 21, 2025
lwasser
commented
Jan 22, 2025
jsdodge
reviewed
Jan 23, 2025
| ### Answer these questions | ||
|
|
||
| * Does the repository accept contributions? If so, what types of contributions are accepted? | ||
| * Does the repository use specific code or text formatting standards or liters? |
There was a problem hiding this comment.
I think there is a typo: "liters" --> "linters"
jsdodge
reviewed
Jan 23, 2025
|
|
||
| In this lesson you will create or comment on an issue that you'd like to fix in GitHub repository that you don't own. | ||
|
|
||
| :::{admonition} Activity: Create (or find) an issue for a bug that you'd like to fix |
There was a problem hiding this comment.
Is there a reason you don't just direct the user to open an issue to fix a specific error in the code or documentation? If the purpose is mainly to walk people through the process of opening an issue, it seems unnecessary to ask the user to look for something to fix in a dummy repository. This confused me initially.
jsdodge
reviewed
Jan 23, 2025
| * [Make your changes on a new branch in your fork.](4-edit-commit-files) | ||
| * [Submit a pull request](5-pull-request) with your updates. | ||
|
|
||
| A gentle nudge is ok if maintainers don't respond after a few weeks. That might look something like this: |
There was a problem hiding this comment.
This seems to repeat the content in lines 79–81.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
These lessons are already online to meet a deadline. However, I wanted to make sure we could have a normal review process on them!
Therefore, this is a hacked branch that allowed me to create a pr with the 4 files in the lessons that can be reviewed as "new" files.
If you want to see the lessons rendered, you can either check Ci OR you can have a look here for context. these lessons do have some images and we can always add more.
I'm looking for feedback on how the lessons read, The goal is to use them in our sprints and to make it easier for people to make first contributions to open source (which we normally have happen in our sprint events!).