Règles
Contrôler le comportement de Verdent via des fichiers de règles
Les fichiers de règles sont des documents Markdown qui définissent le comportement de Verdent pendant les sessions de codage. Ils guident le comportement de l'agent IA, le formatage des sorties et le respect des standards du projet.
Ce que vous allez apprendre
- Comprendre les règles utilisateur et les règles de projet
- Quand utiliser chaque type de règle
- Rédiger des règles efficaces
Types de règles
| Type de règle | Fichier | Portée | Objectif |
|---|---|---|---|
| Règles utilisateur | VERDENT.md | Global (tous les projets) | Préférences de codage personnelles |
| Règles de projet | AGENTS.md | Projet actuel | Conventions d'équipe, standards du projet |
Emplacement :
- Règles utilisateur :
~/.verdent/VERDENT.md - Règles de projet :
<project>/AGENTS.md
Règles utilisateur (VERDENT.md)
Les règles utilisateur vous permettent de personnaliser le comportement de Verdent pour tous les projets.
Accès : Paramètres → Règles utilisateur
Sauvegarde automatique : Les modifications sont sauvegardées automatiquement après 500 ms
- Préférences de style de codage : indentation, conventions de nommage
- Conventions de framework : React, Vue, standards de langage
- Formatage des réponses : niveau de détail, style d'explication
- Préférences de flux de travail personnelles : ton, style de communication
# User Rules
## Code Style
- Always use TypeScript with strict mode
- Prefer functional components over class components
- Use Tailwind CSS for styling
- Follow the project's existing naming conventions
## Communication
- Provide brief explanations
- Show code first, explain after
- Write concise commit messages in conventional formatRègles de projet (AGENTS.md)
Les règles de projet définissent des standards spécifiques au projet actuel. Effectuez un commit dans le contrôle de version pour un partage à l'échelle de l'équipe.
Accès : Panneau Paramètres du projet
Emplacement : Racine du projet (<project>/AGENTS.md)
- Conventions d'équipe : standards de codage partagés
- Architecture : modèles de conception, gestion d'état
- Tests : exigences de couverture, frameworks
- Flux de travail : commandes de build, directives de PR
# AGENTS.md
## Dev Environment
- Run `pnpm install` to set up
- Use `pnpm dev` for local development
## Testing
- Run `pnpm test` before committing
- Minimum 80% coverage required
## PR Guidelines
- Use conventional commit format
- Include tests for new featuresPartagez AGENTS.md avec votre équipe via le contrôle de version pour garantir un comportement IA cohérent auprès de tous les membres de l'équipe.
Rédiger des règles efficaces
Soyez précis :
# Good
- Use async/await for asynchronous operations
- Include JSDoc comments for exported functions
# Avoid
- Try to use modern JavaScript features
- Add comments when necessaryBonnes pratiques :
- Utilisez un langage clair et directif ("Toujours...", "Jamais...", "Préférer...")
- Regroupez les règles liées sous des en-têtes de section
- Gardez les règles concises (un concept par puce)
- Révisez et mettez à jour les règles au fil de l'évolution du projet
FAQ
Comment créer des fichiers de règles ?
Accédez à Paramètres → Règles utilisateur pour modifier VERDENT.md pour vos préférences personnelles. Créez AGENTS.md à la racine de votre projet pour des règles spécifiques au projet. Utilisez du Markdown simple avec des puces.
Quand les modifications de règles prennent-elles effet ?
Les modifications de règles s'appliquent immédiatement dans les nouvelles conversations et influencent les réponses de la conversation en cours.
Puis-je remplacer temporairement les règles ?
Vous pouvez fournir des instructions spécifiques dans votre prompt pour remplacer les règles pour une seule requête.