UCL / UCL/rsd-engineeringcourse

"Git theory" page

Open
#81 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

2018-19
Dominant language
Python
Stars
133
Forks
111
PR merge metrics
No merged PRs in 30d

Description

  • Will students know what a graph is? Maybe a link to a resource? (or just a figure -- I think the log graph isn't very clear if you don't know what you're looking at)
  • The levels of Git:
    • "git reset ": Description sounds more like what git checkout <commit> <filename> does
    • "git reset --hard ": "repostiory" -> "repository"
  • Overall, I'm not clear what the point of this page is, as it mostly repeats things from previous pages without expanding on them that much

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Git theory page and review the listed concerns: explain or illustrate graphs, correct the reset command description and repository typo, and decide how the page should add value beyond earlier material. Done means the page has a clear purpose and addresses each of these content issues.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.