Skip to content

v1.0.0 release prep: API docs, README overhaul, semver commitment #7

Description

@yancya

Scope

Everything needed to call the gem stable and ship 1.0.0.

  • API docs: RDoc/YARD docstrings on RangePpoiString.dump, .parse, both refinements, and the error classes (NoNextError, ParseError) — params, return types, raised errors, examples
  • README overhaul: module-function API as the primary usage example, refinement API as the alternative; a behavior table (valid inputs, error cases, negative numbers, type: Integer); refinement caveats (lexical scoping, Array#to_s shadowing)
  • CHANGELOG: entries for 0.3.0 / 0.4.0 (if not already added per-release) and 1.0.0
  • Release: bump lib/range_ppoi_string/version.rb to 1.0.0, tag v1.0.0, Trusted Publisher workflow ships it

Prerequisites

Acceptance criteria

  • Every public method and error class has a docstring with at least one example
  • README documents both APIs, the error behavior table, and the tag-based release flow
  • CHANGELOG covers every released version up to 1.0.0
  • gem build range_ppoi_string.gemspec succeeds with no warnings
  • CI green; v1.0.0 tag pushed and gem live on rubygems.org (tag push is a human GO)

Verification

gem build range_ppoi_string.gemspec
rake test
# after release: gem info range_ppoi_string --remote

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

No labels
No labels

Projects

No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions