Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upDocumentation needs update #1065
Open
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hi guys, and thanks for a cool project! I find that documentation is sorely lacking in some areas unfortunately.
Under the "Remotes handling" chapter for example, we see this snippet:
there's no indication on how to set up the remote, and judging from this code snippet it's already previously set up? The code doesnt work when I run it in a test script unfortunately.
Maybe creating some simple recipes in the documentation for oft-performed tasks would be an idea?
Like "instantiate a new repo and set up remote". "integrate latest changes to local" "Push dirty state to remote" - you get the idea
I think being super verbose in the documentation helps, both in limiting the number of issues the dev team has to answer and to increase adoption of the library, I think having to go directly to StackOverflow or similar to get answers about basic set up is a sign of lacking documentation:
https://stackoverflow.com/questions/28291909/gitpython-and-ssh-keys
https://stackoverflow.com/questions/41836988/git-push-via-gitpython