ProgSoc Beginners' Git 2024

Originally run 6pm 27th March 2024.

This is the repository for the Beginners' Git workshop.

If your coming from the Live Page, see the guide.md page; and the source code https://github.com/ProgSoc/Git2024

By the end of the Workshop, you'll know about how to manage your files without awkward Assignment-Draft, Assignment-Finalor Assignment-Final1 names, and be able to contribute to open source software projects by opening issues, making and testing changes locally, and submitting Pull Requests to give back to the original project.

Instructions

• Slides: https://docs.google.com/presentation/d/1srdiNmXH5OSu7ADCEZYxBOcBrybGCdaeWRe4vxnqsrU

Installation

• Git: https://git-scm.com/downloads
  • On Windows: Make sure you set "Visual Studio Code" as your editor during setup.
• VSCode: https://code.visualstudio.com/download
• GitHub CLI: https://cli.github.com

Group Session

• Pick 2+ group members (nominate 1 person as Owner),
• Get the Owner to fork this repository,
• Add your teammates as 'Collaborators',
• Create your own individual branches, with a feature name like oli/event-idea:
  • Fill out a new event or project idea in guide.md, with your idea for a event ProgSoc could host,
  • Open a Pull Request, and get the changes merged into the main branch.
• Create your own individual fix branches, with similar feature names to before oli/fix-dates:
  • Each change the date format to a different version (one person does 27/4/2024, another spells out the month fully 27 March 2024, another internationally 2024-03-27, etc)
  • Open Pull Requests, and get the changes merged into the main branch.
  • You'll encounter a merge-conflict, and need to decide how to resolve it.

Live Collaboration Session

• Work on your teams' sections, and submit Pull Requests to the original repository to be merged into the live branch.

Branches

It includes the main branch as a finished state example of the files at the end of the group session.

It also includes the changes submitted during the live website collaboration session, available in the live branch.

Short-Circuit

If you want to jump in at a specific step of the workshop, there are available branches representing the repository state at that point:

• Local Development
  • local/step-0: Empty repository, after git init
  • local/step-1: Imported files from upstream
    • Copy/paste contents from the ProgSoc/Git2024 repository
    • git add README.md guide.md
    • git commit -m "feat: import contents from upstream"
  • local/step-2: Changes made in new branch
    • Create and change to a new branch
      • git switch -c event-idea or
      • git switch -c project-idea
    • Edit guide.md and add your event or project idea
    • git add guide.md
    • git commit -m "feat(guide): event idea"
  • local/step-3: Merged changes into main
    • git switch main
    • git merge event-idea
• Group Development
  • group/step-0: Forked/cloned repository
    • "Fork" on GitHub
  • group/step-1a: Change to full dates
    • git switch -c your-name/full-dates
    • Edit guide.md with full month name changes.
    • git add guide.md
    • git commit -m "fix(guide): full month names"
  • group/step-1b: Change to international dates
    • git switch -c your-name/iso-dates
    • Edit guide.md with international date changes.
    • git add guide.md
    • git commit -m "fix(guide): iso dates"
  • group/step-2: State after merge conflict
    • git switch main
    • git merge your-name/full-dates
    • git merge your-name/iso-dates
    • You'll encounter a merge conflict
  • group/step-3: State after resolving, and running git commit
    • Edit the merge conflict, by accepting/rejecting - either in the VSCode GUI or picking what you want from the <<<<<<<, =======, >>>>>>> delimeters.
    • git commit