Update CONTRIBUTING.md API Documentation section to reference YARD #96

New issue

Open

opened 2026-03-15 04:13:11 +00:00 by freemo · 0 comments

freemo commented

2026-03-15 04:13:11 +00:00

Owner

Metadata

Commit Message: docs(contributing): update API docs section for YARD
Branch: feature/m1-yard-migration

Background and Context

CONTRIBUTING.md currently references RDoc in the API Documentation section. After the
YARD migration, this needs to reference YARD conventions, tags, and the rake yard
command.

Expected Behavior

CONTRIBUTING.md API documentation guidelines reference YARD
Guidelines explain @param, @return, @raise, @example tags
rake yard is the documented command for generating API docs

Acceptance Criteria

All RDoc references in CONTRIBUTING.md replaced with YARD
YARD tag usage guidelines provided
rake yard documented as the generation command

Subtasks

Update API documentation section in CONTRIBUTING.md
Add YARD tag examples and conventions
Update any other RDoc references

Definition of Done

This issue is complete when:

All subtasks above are completed and checked off.
A Git commit is created where the first line of the commit message matches the
Commit Message in Metadata exactly.
The commit is pushed to the remote on the branch matching the Branch in Metadata.
The commit is submitted as a pull request to master, reviewed, and merged.

## Metadata - **Commit Message**: `docs(contributing): update API docs section for YARD` - **Branch**: `feature/m1-yard-migration` ## Background and Context CONTRIBUTING.md currently references RDoc in the API Documentation section. After the YARD migration, this needs to reference YARD conventions, tags, and the `rake yard` command. ## Expected Behavior - CONTRIBUTING.md API documentation guidelines reference YARD - Guidelines explain `@param`, `@return`, `@raise`, `@example` tags - `rake yard` is the documented command for generating API docs ## Acceptance Criteria - All RDoc references in CONTRIBUTING.md replaced with YARD - YARD tag usage guidelines provided - `rake yard` documented as the generation command ## Subtasks - [ ] Update API documentation section in CONTRIBUTING.md - [ ] Add YARD tag examples and conventions - [ ] Update any other RDoc references ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged**.