Docs: Mention Git Requirement in Docs
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 42
- Forks
- 15
- PR merge metrics
- No merged PRs in 30d
Description
Currently, it seems like poetry build requires at least one parent directory to be a git repository. This should be mentioned in the install instructions.
Contributor guide
No contributing guide indexed for this repository
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
Locate the install instructions in the repository and review the steps around poetry build. Update that section to mention that the command requires at least one parent directory to be a Git repository. Done means the requirement is clearly documented for users following the installation process.
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
- 58/100