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

Technical Aspects of Lesson Maintenance revisions #37

Open
angela-li opened this issue Feb 14, 2020 · 1 comment
Open

Technical Aspects of Lesson Maintenance revisions #37

angela-li opened this issue Feb 14, 2020 · 1 comment

Comments

@angela-li
Copy link
Contributor

Starting an issue to keep track of feedback on the last lesson in this series, based on this Maintainer RFC.

Please comment below with any feedback you have on how we can improve the Technical Aspects portion of this lesson!


  • explanations of some of the GitHub specific stuff covered, for example how to keep the lesson up-to-date with the Carpentries styles repo,
  • what is the idea behind the "Squash and Merge" default,
  • how and when to split PRs
  • pull vs. fetch, merge vs commit or add, deleting bad commits (revert-ing and reset-ing), getting a PR to render it locally, origin vs upstream, gh-pages vs master best practices.
  • Local rendering is an important part of self-training, and having a local repo that is even with your Github repo AND the Carpentries repo is important for fully grasping the maintainer and contributor process. Learn this early.
  • Git is a new language to beginners, so a glossary of the commands including flow diagrams (?) might help.

Technical component should teach maintainers how to carry out their daily (and other) tasks:

  • should I "Squash and Merge" or "Create a merge commit"?
  • should I ask to split the PR? (or do it myself -- there is a connection to the non-technical component)
  • how to keep my lesson up-to-date with the styles repo (might be outdated by remote themes)?
@katrinleinweber
Copy link
Contributor

Git […] glossary of the commands including flow diagrams (?) might help.

If none of the git-novice references meets this demand, we could "bless" another of the publicly available cheatsheets.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants