tiny-pilot / tiny-pilot/tinypilot
Document usage of `install-from-souce` dev script
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 3.5k
- Forks
- 291
- PR merge metrics
- No merged PRs in 30d
Description
The usage of the install-from-source dev script is not really documented anywhere, and we could also make it easier to discover.
We should add a section to our contribution guide lines that describes the usage of the script, including:
- The suggested setup around SSH keys for cloning the Pro repo
- A code sample that demonstrates the entire process, e.g. to which location the repo should be cloned, or whether there are any other steps that have to be carried out beforehand
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
Read CONTRIBUTING.md and the dev-scripts/install-from-source script first, then trace the expected repository location and SSH-key setup for cloning the Pro repo. Done means the contribution guide has a discoverable section with the prerequisites, suggested SSH setup, and a complete example of using the script.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100