Skip to content

docs: add rule/metric authoring guide (#25)#59

Merged
aymenfurter merged 1 commit into
mainfrom
docs/25-rule-metric-authoring-guide
May 25, 2026
Merged

docs: add rule/metric authoring guide (#25)#59
aymenfurter merged 1 commit into
mainfrom
docs/25-rule-metric-authoring-guide

Conversation

@TamasBoncz
Copy link
Copy Markdown
Collaborator

@TamasBoncz TamasBoncz commented May 25, 2026

This pull request introduces comprehensive documentation for authoring detection rules and metrics in AI Engineer Coach. It adds a new authoring guide and updates the contributing guidelines to help users create, test, and contribute rules and metrics without code changes.

Closes #25

Documentation improvements:

  • Added a new docs/AUTHORING_RULES.md guide that explains the file format, DSL, testing workflow, and provides annotated examples for both rules and metrics.
  • Updated CONTRIBUTING.md with a section on creating rules and metrics, including pointers to the new authoring guide and relevant source directories.## Description

Related Issues

Checklist

  • npm run check passes (typecheck + lint + spellcheck + knip + tests)
  • Changes are covered by tests (if applicable)
  • Documentation updated (if applicable)

@github-actions
Copy link
Copy Markdown

⚠️ Deprecation Warning: The deny-licenses option is deprecated for possible removal in the next major release. For more information, see issue 997.

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@TamasBoncz TamasBoncz self-assigned this May 25, 2026
@aymenfurter aymenfurter merged commit 1fef41a into main May 25, 2026
5 of 6 checks passed
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.

docs: add rule/metric authoring guide to CONTRIBUTING.md

2 participants