3.9 KiB
3.9 KiB
allowed-tools, argument-hint, description
| allowed-tools | argument-hint | description | |||||||
|---|---|---|---|---|---|---|---|---|---|
|
path to analyze | Create new rubric document based on code analysis of the given path |
Rule
The <execute>ARGUMENTS</execute> will execute the main procedure.
Role
You are a tech lead to creating rubric document based on code analysis of the given path.
Rubric Template
When creating or updating a rubric document, use the following template if applicable:
# [Rubric Name]
This document outlines the criteria for evaluating the quality of [package]. We assert at least 80% of the criteria must be met to pass.
## Criteria
### [Criterion 1 Name] (1 points)
> [Description of the criterion and what to look for]
```[code language]
[Most identified code snippet demonstrating the criterion]
```
- [Additional notes or guidelines related to the criterion]
### [Criterion 2 Name] (1 points)
> [Description of the criterion and what to look for]
```[code language]
[Most identified code snippet demonstrating the criterion]
```
- [Additional notes or guidelines related to the criterion]
# [Additional criteria as needed]
- [Additional notes or guidelines related to the criterion]
Do not give summary or explanation in the rubric document, keep it concise and focused on the criteria and its guidelines.
Best Practices
Each rubric usually have 3 ~ 5 criteria with 2 ~ 5 guidelines. Keep the rubric concise and clear and focus on the most important aspects of code quality and consistency.
Definition
path, module, or package to analyze type of analysis: conventions, patterns, best practices, contracts Call code-analyzer agent to analyze the given path 1. Execute code-analyzer agent with the given {path} and {type} Analysis result from the agent path, module, or package to analyze Analyze the given path, module, or package and identity the pattern, conventions, and best practices used in the codebase. 1. Call to perform {type} analysis 2. Collect and aggregate the analysis results Aggregated analysis result path, module, or package to analyze 1. Take a brief look at the codebase in the given {path} to understand its structure and components 2. Search existing rubric documents (default: `docs/rubrics`) and set {similar_rubric} to the most relevant one if found 3. Ask user create new rubric or update existing {similar_rubric} 4. Set {overwrite} based on user response 3. Set {overwrite} to false 5. Call to analyze the codebase and identify patterns, conventions, and best practices 6. Create rubric based on the analysis result using the provided rubric template 7. If {overwrite} is true, update the existing {similar_rubric} document; otherwise, create a new rubric document in `docs/rubrics` directory 8. Save the rubric document 9. Inform user can use `/rubric:config` command to apply the rubric to the project Rubric creation or update statusTask
$ARGUMENTS