jupyterhub / jupyterhub/nbgitpuller

Document that end users shouldn't be running `git` commands manually where nbgitpuller clones

Open
#370 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
237
Forks
86
PR merge metrics
No merged PRs in 30d

Description

nbgitpuller expects to have full ownership of the cloned git repository. If the user is manually running `git` commands there, it will eventually break. This is an *essential* complexity of nbgitpuller - its goal is to abstract away git usage from the end user, so it makes assumptions about how git is used. Many things a user can do (particularly switching branches) breaks these assumptions.

If the user wants to run `git` commands locally, they should make a clone with `git clone`.

## Definition of done

- [ ] This information is prominently documented

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.