databrickslabs / databrickslabs/pytester
[Doc] missing Getting started section in README
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 139
- Forks
- 16
- PR merge metrics
- No merged PRs in 30d
Description
The README document presented in a format of API doc while missing a section briefing how to getting started.
It is hard for me to figure out a getting started path even:
- I have learnt pytest fixture document
- I guess I should import some, but cannot find the right import(s) to those mentioned in document.
- Some imports looks relevant, but their naming conflict with document
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 by reading the existing README and the pytest fixture documentation referenced in the issue. Add a Getting started section that gives readers a clear path, identifies the relevant imports, and resolves naming conflicts with the current documentation; done means a newcomer can follow the README to begin using the project.
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
- 48/100