Skip to content

docs(#3906): add scorecard workspace AGENTS.md with metric IDs#3907

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/3906-scorecard-agents-md
Open

docs(#3906): add scorecard workspace AGENTS.md with metric IDs#3907
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/3906-scorecard-agents-md

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown
Contributor

Add workspace-level AGENTS.md for the scorecard workspace to provide agents with reference material for metric ID naming conventions and the complete set of known metric IDs across all 6 providers (GitHub, Jira, Dependabot, SonarQube, OpenSSF, Filecheck -- 36 static metrics total).

The file documents:

  • The lowerCamelCase naming convention for metric IDs
  • A complete reference table of all metric IDs by provider
  • OpenSSF edge cases where check names contain consecutive
    uppercase characters (CII-Best-Practices, CI-Tests, SAST)
    that require careful camelCase conversion
  • A checklist for changes to metric ID generation covering
    provider source, translations, config schema, app-config,
    and tests

This addresses the gap that contributed to a regex bug in PR #3534 where the code agent lacked workspace-level docs about metric ID conventions and known check names.


Closes #3906

Post-script verification

  • Branch is not main/master (agent/3906-scorecard-agents-md)
  • Secret scan passed (gitleaks — 838a80deb2bb24c16522cf7c5a159331cff8aef6..HEAD)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

Add workspace-level AGENTS.md for the scorecard workspace to
provide agents with reference material for metric ID naming
conventions and the complete set of known metric IDs across
all 6 providers (GitHub, Jira, Dependabot, SonarQube, OpenSSF,
Filecheck -- 36 static metrics total).

The file documents:
- The lowerCamelCase naming convention for metric IDs
- A complete reference table of all metric IDs by provider
- OpenSSF edge cases where check names contain consecutive
  uppercase characters (CII-Best-Practices, CI-Tests, SAST)
  that require careful camelCase conversion
- A checklist for changes to metric ID generation covering
  provider source, translations, config schema, app-config,
  and tests

This addresses the gap that contributed to a regex bug in
PR #3534 where the code agent lacked workspace-level docs
about metric ID conventions and known check names.

Closes #3906
@codecov

codecov Bot commented Jul 21, 2026

Copy link
Copy Markdown

⚠️ JUnit XML file not found

The CLI was unable to find any JUnit XML files to upload.
For more help, visit our troubleshooting guide.

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

Labels

ready-for-review Agent PR ready for human review workspace/scorecard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add scorecard workspace AGENTS.md with metric ID conventions and known check names

0 participants