Documentation is missing pygit2 install from repository checkout instructions
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 408
- Avg merge
- 2d 57m
- Merged PRs (30d)
- 7
Description
The Advanced installation instructions don't provide any guidance on installing pygit2 from a repository checkout.
There are instructions for installing libgit2 but then for pygit2 it only says the following:
Now install pygit2, and then verify it is correctly installed:
$ pip install pygit2
This will install the latest released version but not a version checked out from the repository.
Looking at what is provided in the Makefile the following is a reasonable guess and seems to work
cd pygit2
sudo python install
or in my case sudo python3 install.
It would be helpful if the documentation contained some verification that this is recommended method when installing from a repository checkout.
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
Start with the Advanced installation instructions and the repository's Makefile. Compare the existing libgit2 and pygit2 steps, document the supported way to install pygit2 from a repository checkout, and include verification that the checkout version was installed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 58/100