UCL / UCL/rsd-engineeringcourse
"Solo work with Git" page
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 133
- Forks
- 111
- PR merge metrics
- No merged PRs in 30d
Description
-
We should clearly explain what the purpose of the staging area is. Why does git have a 2-step approach for committing code?
-
The commit -a option is mentioned. If it is true that this should not be done, we need to explicitly state why.
-
Near the end it introduces "index" and "repo" without explaining what these are.
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
Open the “Solo work with Git” page and review the sections covering the staging area, the commit -a option, and the terms “index” and “repo.” Clarify the purpose of Git’s two-step commit process, explain why commit -a may be discouraged, and define the unfamiliar terms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100