Skip to content

docs(#4334): add new-module creation conventions to scorecard AGENTS.md #4336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
fullsend-ai-coder wants to merge 1 commit into
base: main
Choose a base branch
from
+11 −0
Open

docs(#4334): add new-module creation conventions to scorecard AGENTS.md #4336

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions workspaces/scorecard/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,17 @@
- Lint: `yarn lint:all`
- Type check: `yarn tsc`

## New Module Creation

When creating a new scorecard backend module under `plugins/`:

1. Set `version` in `package.json` to `0.0.0` (the first changeset bumps it to `0.0.1`).
2. Create a changeset at `workspaces/scorecard/.changeset/<descriptive-name>.md` with a `patch` bump for the new package.
3. After adding public exports, generate the API report: `yarn tsc && yarn build:api-reports:only` from the scorecard workspace.
4. Create a `README.md` with: feature overview, prerequisites, installation instructions, and app-config configuration examples.
5. In `config.d.ts`, use `@visibility frontend` or `@visibility backend` for non-sensitive fields. Only use `@deepVisibility secret` for fields that contain credentials, tokens, or other genuinely sensitive values. Catalog entity filters (e.g., `kind: Component`) are not sensitive.
6. Run `yarn prettier:fix` from the scorecard workspace before committing.

## Metric ID Naming Convention

All metric IDs use `lowerCamelCase` with a `<provider>.<metricName>` format:
Expand Down
Loading