wordpress-mobile / wordpress-mobile/release-toolkit
Update the release-toolkit README.md
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 31
- Forks
- 10
- Avg merge
- 5h 45m
- Merged PRs (30d)
- 2
Description
The README of this repo would benefit from being more helpful and providing information for devs about, amongst other things:
- How to run RSpecs
- How to generate YARD doc to get documentation about its actions and the code
- Description of the folder hierarchy / organization in the codebase: actions vs helpers, ios vs android vs common, …
- How to configure VSCode to be able to navigate into the ruby codebase with ease (it's arguably not specific to this repository, but would still be helpful to include a quick paragraph / pointer to tips and plugins that will help contributors a lot in working on this)
- …
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 with README.md and inspect the repository’s existing RSpec and YARD usage, folder hierarchy, and Ruby development setup. Document how to run RSpec, generate YARD documentation, understand actions versus helpers and iOS, Android, and common areas, and configure VSCode for Ruby navigation. Done means the README covers these contributor workflows and repository conventions clearly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100