agentleFS
haruharu/redmine_ai_helper/.claude/skills/regression-check/SKILL.md

regression-check

Skill107 starsChanged 9 months agoMITView on GitHub

Run the full regression suite for the redmine_ai_helper plugin (YARD doc coverage, RuboCop, and the plugin test suite) via .devcontainer/regression-check.sh

2 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

2 rules. About 0 are common, 1 is distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Run the plugin's full regression check: YARD documentation coverage, RuboCop linting, and the complete Minitest suite.

    line 8
  2. Very specific:

    Must be run from a shell that can cd into /usr/local/redmine — the script assumes the plugin lives at …

    line 40

≈ “Common” is an estimate: at least 1 in 5 of the 364,980 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Regression Check

Run the plugin's full regression check: YARD documentation coverage, RuboCop linting, and the complete Minitest suite.

Workflow

Step 1: Run the regression script

sh -x .devcontainer/regression-check.sh

The script (.devcontainer/regression-check.sh) does the following, in order, aborting on the first failure (set -ex):

  1. cd into the plugin root
  2. yard stats --list-undoc | tee /dev/stderr | grep -q "100.00%" — fails if documentation coverage drops below 100%
  3. rubocop — fails on any offense
  4. cd /usr/local/redmine then bundle exec rake redmine:plugins:test — runs the full Redmine test suite (all plugins, not just NAME=redmine_ai_helper)

Step 2: Triage failures

  • YARD gap: find the newly undocumented module/class/method/constant/attribute and add a doc comment.
  • RuboCop offense: fix per the rubocop skill's guidelines (see .claude/skills/rubocop/SKILL.md); never relax .rubocop.yml thresholds without explicit user approval.
  • Test failure/error: investigate the failing test, fix the underlying code (never disable or delete the test to make it pass), then re-run.

Step 3: Re-run until clean

Re-run the script after each fix until it exits 0 with:

  • 100.00% documented
  • no offenses detected
  • 0 failures, 0 errors, 0 skips

Notes

  • Must be run from a shell that can cd into /usr/local/redmine — the script assumes the plugin lives at /usr/local/redmine/plugins/redmine_ai_helper.
  • This runs the entire Redmine test suite (all plugins), which takes noticeably longer than rake redmine:plugins:test NAME=redmine_ai_helper. Use the narrower NAME= form for quick iteration while fixing a single test, and this skill for the final full check.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.