ruby / ruby/rdoc

Add a CI job for SDoc

Open
#1,331 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
930
Forks
465
Avg merge
3d 10h
Merged PRs (30d)
27

Description

It'll prevent introducing breaking changes for SDoc.

See also: https://github.com/ruby/rdoc/pull/1304#issuecomment-2749251458

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 with the discussion linked from the issue and inspect the repository's existing CI configuration to understand how SDoc is currently exercised. The work is complete when CI includes an SDoc job that detects breaking changes without disrupting the existing checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
ci-cd
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.