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

Improve introduction of pull requests #463

Closed
tobyhodges opened this issue Dec 4, 2024 · 0 comments · Fixed by #469
Closed

Improve introduction of pull requests #463

tobyhodges opened this issue Dec 4, 2024 · 0 comments · Fixed by #469
Labels
Collaboration Skills issue related to the parts of the curriculum teaching collaboration skills type:clarification Suggest change for make lesson clearer
Milestone

Comments

@tobyhodges
Copy link
Member

How could the content be improved?

We introduce the concept of branches just before the pull request demo+exercise, and I still find it difficult to do this elegantly and efficiently, e.g. judging the right level of detail to provide that will make sense without getting stuck in the weeds of a topic that can be conceptually rather heavy. I would like to expand/polish up the introductory paragraph.

One analogy I have used successfully is to the "Suggestion mode" of GoogleDocs, describing the PR workflow as similar to suggesting edits to somebody else's document: it is more polite, easier to keep track of what changes are being made and by whom, and provides a quality control step.

I also think this is a part of the curriculum that could really benefit from an illustration to share during training.

Which part of the content does your suggestion apply to?

https://carpentries.github.io/lesson-development-training/collaborating-team.html#managing-contributions

@tobyhodges tobyhodges added type:clarification Suggest change for make lesson clearer Collaboration Skills issue related to the parts of the curriculum teaching collaboration skills labels Dec 4, 2024
@anenadic anenadic added this to the 2024 release milestone Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Collaboration Skills issue related to the parts of the curriculum teaching collaboration skills type:clarification Suggest change for make lesson clearer
Projects
None yet
2 participants