lincc-frameworks / lincc-frameworks/lf-workflow-dash
Please improve the "setup" instructions
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9
- Forks
- 9
- PR merge metrics
- No merged PRs in 30d
Description
Seems to be the setup script is hidden as a .setup_dev.sh file, and isn't mentioned in the top level README. Please document the requirements (pip >= 22).
Thanks, cool project.
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
Start by reading the hidden .setup_dev.sh script and the top-level README. Document the setup script and its pip >= 22 requirement in the README; the work is done when a newcomer can find and follow the setup instructions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100