jupyterhub / jupyterhub/nbgitpuller
Document that users shouldn't actively be running git commands along with nbgitpuller
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 237
- Forks
- 86
- PR merge metrics
- No merged PRs in 30d
Description
nbgitpuller is meant as a distribution mechanism. If users are also actively running git commands on the nbgitpuller checkout, switching branches, etc, nbgitpuller is going to get into inconsistent states it can't get out of.
We should document this prominently somewhere!
Contributor guide
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
Review the existing nbgitpuller documentation and the checkout workflow described in the issue first. Add prominent guidance that users should not run git commands, switch branches, or otherwise actively manage the checkout, and verify that the warning clearly explains the risk of inconsistent states.
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