mozilla-services / mozilla-services/updatebot
Clarify setup instructions and process
Open
Nobody has claimed this yet.
Docs
Easy
P3
- Dominant language
- Python
- Stars
- 9
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
After going thru the setup instructions with someone there were a few spots that the README could be made better and this is probably the most glaring
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
Review the README's setup instructions and the setup process described in this issue, noting the spots that were confusing during the walkthrough. Clarify the identified instructions and process details in the README; done means a new reader can follow the setup without the reported confusion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100