Skip to content

chore: align AI assistance guidance and add OpenSSF Scorecard publishing and its dynamic badge. - #19

Merged
terabytesoftw merged 2 commits into
mainfrom
chore/align-ai-assistance-and-scorecard-openssf
Nov 12, 2026
Merged

terabytesoftw merged 2 commits into
mainfrom
chore/align-ai-assistance-and-scorecard-openssf

Conversation

@terabytesoftw

Copy link
Copy Markdown
Contributor

Pull Request

  • Breaking change (fix or feature that would cause existing functionality to change)
  • Bugfix (non-breaking change that fixes an issue)
  • CI/build configuration
  • Dependency update
  • Documentation update
  • New feature (non-breaking change that adds functionality)
  • Performance improvement
  • Refactoring (no functional changes)
  • Tests

Change

Explain the problem and the resulting behavior. Include a before/after example when useful.

Validation

List the checks performed and their results. Explain any relevant checks not run.

Compatibility

Describe any behavior, configuration, dependency, or migration impact. Write "None" when there is no compatibility
impact.

Related issues

Link relevant issues. Use closing keywords only when this PR fully resolves them.

@terabytesoftw terabytesoftw added the documentation Improvements or additions to documentation label Nov 12, 2026
@coderabbitai

coderabbitai Bot commented Nov 12, 2026 •

Copy link
Copy Markdown

Explain Change →

Caution

Review failed

The pull request is closed.

Summary

Summary by CodeRabbit

  • Documentation
    • Updated guidance for discovering and using the coding-standard skill across supported AI coding tools, including installation, activation, and verification steps.
    • Expanded examples to cover PHP version targets and safe, non-mutating checks.
    • Clarified how to configure and verify coding-standard wrappers, including handling existing configurations.
    • Updated project status and security information.
  • Chores
    • Updated quality and security workflow integrations and added scheduled security scorecard reporting.

The pull request updates three reusable workflow references, adds a scheduled and event-triggered Scorecard workflow, and revises AI assistance guidance in the README, agent guide, and package skill.

Changes: CI Workflow Changes

Layer / File(s) Summary
Update shared workflow pins
.github/workflows/ecs.yml, .github/workflows/quality.yml, .github/workflows/security.yml
The ECS, quality, and security jobs now use php-forge/actions v3.0.2.
Add Scorecard publishing
.github/workflows/scorecard.yml, README.md, CHANGELOG.md
A new workflow runs on branch-protection-rule events, pushes to main, and a weekly schedule. It calls the pinned reusable workflow with publishing enabled. The README adds security badges, and the changelog records the Scorecard update.

AI Assistance Guidance

Layer / File(s) Summary
Document skill behavior and wrapper handling
skills/php-forge-coding-standard/SKILL.md
The skill describes ECS and Rector entrypoint selection, PHP-version rule coverage, wrapper scaffolding in preserve mode, and non-mutating verification.
Document skill installation and discovery
docs/agents.md
The guide adds Composer and npx setup instructions, client discovery paths, invocation methods, and checks for synchronization and activation.
Document prompts and verification
docs/agents.md, README.md
The guide adds PHP-version prompts and verification steps. The README adds AI assistance guidance and links to skill resources.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Change: Other

Possibly related PRs

Merge Risk: Low · up to 63e85

The new agent setup guide tells users to install the package with Composer and sync the skill. Until a release containing the skill is published, the documented ^0.3 constraint resolves to 0.3.4, which does not include it. This affects documentation only and should resolve when 0.3.5 ships; publish that release or clarify the guidance around it.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

A rabbit checks the workflow trail,
New Scorecard runs join the rail.
The skill notes paths and PHP rules,
With careful checks and wrapper tools.
I nibble docs, then hop away.

@terabytesoftw
terabytesoftw merged commit c543ed6 into main Nov 12, 2026
20 of 21 checks passed
@terabytesoftw
terabytesoftw deleted the chore/align-ai-assistance-and-scorecard-openssf branch November 12, 2026 23:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant