Visitar URL original
BCQuality/docs at main · microsoft/BCQuality · GitHub
Skip to content

Latest commit

 

History

History

docs

README.md

BCQuality documentation

New to BCQuality? Start with the quick start. Install the plugin, discover its skills, and try an app review. No knowledge of BCQuality's internal protocol is needed.

Partner guides

Goal Guide
Choose direct reading, a supplied skill, or my own agent Ways to use BCQuality
Review an app, file, changes, or branch Using BCQuality
Support design and specification with cited knowledge Knowledge consultation
Understand a report and its limitations Reading your results
Find a particular rule or example Knowledge by domain
Fix setup problems or report an incorrect finding Troubleshooting and support
Select layers, add company rules, or maintain a fork Customizing BCQuality
Add or improve shared knowledge Your first contribution

Integration and technical reference

These pages are for people building integrations or maintaining skills, not prerequisites for using the plugin.

Reference Purpose
Minimal integration example A bootstrap prompt connecting your agent to a BCQuality checkout and an app folder.
How agents consume BCQuality Architecture, repository structure, routing, and delivery of findings.
Plan guidance integration (preview) Apply BCQuality constraints to an existing development plan before implementation.
Standalone runner Optional model selection, scheduling, retries, and telemetry.
SARIF export Show accepted findings as code scanning annotations in GitHub or Azure DevOps.
Global skills Host adapters versus internal protocol files.
Knowledge-response validation Optional consumer checks for question fidelity and complete citation reads.
Entry Task context and skill dispatch.
READ Knowledge schema, applicability, and precedence.
DO Action-skill format and structured output contract.
WRITE Knowledge-authoring rules.
Review evaluation Sample conventions, fixture preparation, and scoring.