dwyl / dwyl/git-guide

Git Guide: Comprehensive Update

Open
#26 0 comments 1 reaction 1 assignee Claimed by @nelsonic View on GitHub
discuss enhancement help wanted
Dominant language
No language data
Stars
44
Forks
3
PR merge metrics
No merged PRs in 30d

Description

There is clearly a Gap in our Git/GitHub learning for _beginners_. 🔰 ⏳
We are seeing this (_again_) with @davcsj who is just starting his journey into coding ... 🧑‍💻

Last time we mentored a coding newbie they ended up getting stuck (_a lot_) on `Git` & `GitHub`:
https://github.com/dwyl/apprenticeship/issues?q=is%3Aopen+is%3Aissue+git

image

As noted in: https://github.com/dwyl/apprenticeship/issues/25#issuecomment-578342728 we have a section on Git + Github in the [start-here/README.md#git](https://github.com/dwyl/start-here/blob/63468a6bc020f88c762465823da7419478f29687/README.md#git--github)
![image](https://github.com/user-attachments/assets/396669bd-c0d1-4027-962b-b8daae98b693)

but that is _clearly_ not enough to help beginners get over the _initial_ hurdle. 😞

What we need is a clear checklist/roadmap of what _beginners_ need to learn
so that they don't go down rabbit holes and off on tangents learning things they don't _need_.

So I'm thinking of repurposing _this_ repo, which hasn't been updated in a `while` ...
https://github.com/dwyl/github-reference

![git-guide-last-updated-8-years-ago](https://github.com/user-attachments/assets/f99d7218-9e57-4548-9744-15ce4e54283a)

# `#discuss` 💭

+ [ ] Rename the repo from `github-reference` to `git-guide` for brevity? ✂️
+ [ ] Update the tag line from:
"GitHub reference for *non-technical* people following a project's progress"
to:
"Get good at git. Learn all you need to use GitHub effectively.

+ [ ] Retain the "Non-technical" content; but ...
+ [ ] Update the screenshots to latest interface.
+ [ ] Add a _general_ section on registering for a `GitHub` Account.
+ [ ] Computer setup! some of which is covered in https://github.com/dwyl/dev-setup but it too is incomplete! 😞 (though I updated it a bit last year ...)

# Todo ✅

+ [ ] Revise the list of `GitHub` Features we use most often.
+ [ ] Search the org for a keyword 🔍
+ [ ] Comment on an _existing_ issue. 💬
+ [ ] Open a **`new`** issue for the idea you have or problem you want to report. 🆕
+ [ ] Create a Pull Request to update a Repo on GitHub (without cloning to Computer)
+ [ ] Prepare a short list of the useful `git` commands
+ [ ] Clone a Repo to `localhost` both using `ssh` and `https`
+ [ ] Create a new branch
+ [ ] Create a change in the code/readme
+ [ ] **`commit`** changes
+ [ ] Push to `GitHub`.
+ [ ] Create Pull Request based on the change.

# Video? 📺

I feel like we should record a _video_ (or a _few_) on this topic
and then capture the screens from the video for the written guide.

e.g: First video:
"Your first 10 minutes of `GitHub` and `Git`.
From registration, account setup, and basic interaction."

Second Video:
Your first _contribution_ on `GitHub` Opening an Issue and making an update (pull request).

Third Video:
"Clone, Update, Commit, Push!"

Thoughts? 💭

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.