wordpress-mobile / wordpress-mobile/release-toolkit

Add YARD documentation to release-toolkit actions

Open
#192 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
31
Forks
10
Avg merge
5h 45m
Merged PRs (30d)
2

Description

Add YARD documentation to all the methods in release-toolkit, especially the methods on actions and helpers.

Part of this task will likely be tackled in parallel to the code rearrangement / refactoring in #191 – as we plan to write YARD documentation for new code as it is being refactored / rewritten. But this issue will cover more than #191 as we need to also document even code that won't really need to change / be refactored.

  • Helpers
    • *_version_helper iOS + Android (🚧 WIP)
    • *_git_helper iOS + Android (🚧 WIP)
    • Other iOS helpers (🚧 WIP)
    • Common (non-platform-specific) helpers
  • Actions
    • Android actions
    • iOS Actions
    • Common Actions
    • Configure Actions

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the Ruby helpers and actions in release-toolkit alongside the code rearrangement described in #191. Work through the listed iOS, Android, common, and configure areas, and consider how refactoring affects the documentation. Done means the methods in all listed categories have YARD documentation, including code that is not refactored.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation, tooling
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.