Home

Welcome to the git-github-zero-to-hero wiki! This wiki is used for capturing notes and tips for the delivery of this course.

Instructor Tips

Technical 💻

Screen layout

• Small screen teaching, share screen with chrome window and gtikraken.
• Large screen Blackboard collaborate, ensuring I can see emoji status updates, on one window and course materials on another.

GitKraken

• Command Palette: When creating new files, ensure you leave the path up long enough. Request feedback.

• Before beginning working on issue, ensure all team members have found their issue and are looking at it.

• Issue with accepting (finding) GitHub invitations: https://github.community/t/where-do-i-see-all-incoming-invitations-collaborator/661/4.

  • Solution: You can also see the invite if you know which repo you were invited to: https://github.com/username/reponame/invitations

• Issues with GitKraken on UBUNTU: installation issue: Solution add note to setup instructions about testing UBUNTU especially and getting in touch if they have issues before course. Appearance issue (not sure what this is?)

Blackboard

• As a moderator/instructor, join the session through https://vle.shef.ac.uk/ > Organisations > Research Software Engineering > find the day's session and join.
• When asking for yes/no responses on recording the session, use a poll to more easily see who a response is needed from.
• Use emoji responses (or chat) for assessing whether participants are following. Use raised hands for critical problems that might need assistance.

Delivery Notes 🧑‍🏫

00. Introduction to Version Control

• stress that git is a piece of software on your computer; GitHub is a website/platform
• Stop for questions periodically - after git & GitHub, before GitKraken client
• Licenses
  • Code and other types of content (e.g. photos) have different sorts of license (e.g. CC-BY)
• Might be worth noting that "repositories" are a git concept, as well as the way that they are presented on GitHub.

01. Getting started with git and GitHub

• Before this section, and before the break, check that everyone is set up and has their SSH key (or whatever) authentication set up.

02. Websites with GitHub Pages

• Explain why markdown is useful outside of GitHub pages?
• Explain GitHub pages source location, why you would choose / (root) vs docs/ for instance.
• Sometimes it can be slow to build everyone's webpages - just allow time here.

03. Cloning and Collaborating with GitKraken Client

04. Advanced Collaboration with GitHub

FAQs

• What's the command palette shortcut?

  • Ctrl + p or cmd + p

• I got this error: "Push main: Push failed on refs/heads/main: push declined due to email privacy restrictions"

  • Quick fix: go to: https://github.com/settings/emails to open your account's email settings, uncheck Block command line pushes that expose my email
  • Long-term fix: (via https://stackoverflow.com/questions/43378060/meaning-of-the-github-message-push-declined-due-to-email-privacy-restrictions)
    • Under https://github.com/settings/emails, if Keep my email address private is checked, get the {ID}+{username}@users.noreply.github.com
    • Open a GitKraken CLI window
    • Type git config --global user.email {ID}+{username}@users.noreply.github.com with {ID} and {username} replace with your values from above, and hit Enter
    • Type git commit --amend --reset-author and hit Enter to amend the author of the previous commit
    • Now push the amended commit, either with git push from the CLI, or pushing using GitKraken Client.