Skip to content

[#17] Mention serokell_danger as an optional CI check - #18

Draft
heitor-lassarote wants to merge 1 commit into
mainfrom
heitor-lassarote/#17-mention-danger-gem-in-setup-ci
Draft

[#17] Mention serokell_danger as an optional CI check#18
heitor-lassarote wants to merge 1 commit into
mainfrom
heitor-lassarote/#17-mention-danger-gem-in-setup-ci

Conversation

@heitor-lassarote

Copy link
Copy Markdown
Member

Description

The setup-ci skill's "Common checks (apply everywhere)" section
listed reuse lint, no-trailing-whitespace, xrefcheck, and
shellcheck, but said nothing about the serokell_danger gem, even
though it overlaps with some of those same checks. An agent following
setup-ci/bootstrap-repo had no way to discover the gem exists.

Added an "Optional: Danger checks for PR/MR review" section pointing
to serokell/danger's README and to metatemplates' docs/danger.md
for the Gemfile/Dangerfile snippet and CI wiring. Kept it out of
the mandatory "Common checks" list, since it needs a Ruby/Bundler
toolchain unlike the language-agnostic checks already there.

Depends on serokell/metatemplates#31:
the docs/danger.md link only resolves once that PR merges, so
xrefcheck is expected to fail here until then. Opened as a draft for
that reason; will mark ready once #31 lands.

Related issue(s)

Fixed #17

✅ Checklist for your Pull Request

Related changes (conditional)

  • Tests

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from
      silently reappearing again.
  • Documentation

  • Agent instructions (conditional)

    • If this PR was opened by a coding agent (Claude Code, Copilot, etc.),
      it followed the agent instructions in plugins/serokell-global/skills/
      and .github/copilot-instructions.md.
  • Public contracts

    • Any modifications of public contracts comply with the Evolution
      of Public Contracts
      policy.
    • I added an entry to the changelog if my changes are visible to the users
      and
    • provided a migration guide for breaking changes if possible

Stylistic guide (mandatory)

Problem: The setup-ci skill's "Common checks (apply everywhere)"
section lists reuse lint, no-trailing-whitespace, xrefcheck, and
shellcheck, but says nothing about serokell_danger, even though it
overlaps with some of those same checks. An agent following
setup-ci/bootstrap-repo has no way to discover this gem exists.

Solution: Add an "Optional: Danger checks for PR/MR review" section
pointing to serokell/danger's README and metatemplates' docs/danger.md
for the Gemfile/Dangerfile snippet and CI wiring. Kept out of the
mandatory "Common checks" list since it needs a Ruby/Bundler
toolchain, unlike the language-agnostic checks already there.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Mention serokell_danger as an optional CI check in setup-ci

1 participant