Git Workshop (2024)

From Nottinghack Wiki
Revision as of 09:12, 7 February 2024 by Asj (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This workshop was motivated by some edits to the members guide. This guide uses a service called Read The Docs, which turns ugly reStructuredText into a (stylish) web site. The members' guide is one example of how Git can be used by "non programmers". This workshop will focus on such use cases, so there is no need to understand how to program, you can still learn to get benefits from Git.

When? the 21th of February (2024) at 8pm Where? the comfy area because it's comfy

What even is Git?

Git is a version control system. There have been many before it, and will likely be many after it. It allows you to maintain a full history of all changes to text, whether that be the members' guide, some software, or your todo list.

What will we do?

We'll keep the workshop under 2 hours and will cover the following:

  • Installing Git (you can do this before hand if you like)
  • Cloning a repository (what even is a repository?)
  • Creating a branch and making a change
  • Opening a pull request

The goal will be to make a contribution to the hackspace members' guide.

What do I need?

You will need the following:

Some Contribution Ideas

You should take a look at our members guide - https://guide.nottinghack.org.uk - there are a bunch of things that can be improved, I'm sure you'll spot many! The idea with Git is to try and constrain changes to a single commit, so we'll just focus on one or two things each for the time being.

  • Replacing instances of "Members Guide" or "Member's Guide" with "Members' Guide"
  • Adding a regular event to the Regular Events page, or improving a description
  • Improve the description for your favourite area of the space (under the Areas and Room page)
  • Give a list of the usual kind of snacks available in Snackspace
  • Expand on some of the Team descriptions

See, lots of ideas. :)