UCL / UCL/rsd-engineeringcourse
"Fixing mistakes" page
Open
Nobody has claimed this yet.
2018-19
- Dominant language
- Python
- Stars
- 133
- Forks
- 111
- PR merge metrics
- No merged PRs in 30d
Description
- Referring to changes with HEAD and ^: Repetition in last paragraph (using hash to refer to commit)
- Reverting: "A commit may pop up" -> "An editor"?
- Covering your tracks: "The silly spelling is gone", except it's not; only the committing has been undone, not the actual changes
- Last diagram:
- commit -a should go from Jim to repo in one arrow (like in diagram above)
- reset is also different to diagram
- Should checkout go from index to Jim, or from repo to Jim? (also affects diagram above)
- Be more consistent with staging area and index? Or do we want them to be used to both terms?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the “Fixing mistakes” page in the course materials and review the listed paragraphs and diagrams. Check the explanations of HEAD, reverting, resetting, checkout, commit -a, and the staging area against the surrounding diagrams. Done means the wording and diagrams accurately and consistently describe the Git operations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100