WinRepo requirements should be more clear
Open
Nobody has claimed this yet.
Confirmed
documentation
severity-medium
time-estimate-single-day
Windows
- Dominant language
- Python
- Stars
- 15.7k
- Forks
- 5.6k
- Avg merge
- 2d 44m
- Merged PRs (30d)
- 80
Description
Description of Issue
GitPython 0.3 or later, or pygit2 0.20.3 with libgit 0.20.0 or later installed on your Salt master. The Windows package definitions are downloaded and updated using Git.
It's not clear in the above that libgit2 is a system package and should be installed from the OS package repo, not pip.
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
Search the documentation for the WinRepo requirements text quoted in the issue. Review the wording around GitPython, pygit2, and libgit2, then make clear that libgit2 is a system package to install from the operating system package repository rather than pip. Done means the requirement no longer suggests installing libgit2 with pip.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- git, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100