FRmicrow/readme-guidelines
.claude/skills/documentation/readme-guidelines/SKILL.md
Structurer un README utile. Utiliser quand on rédige ou met à jour la documentation du projet.
documentation
Updated Apr 16, 2026
$ install --global
skillsauthnpx skillsauth add FRmicrow/dataFootV1 readme-guidelinesInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 16, 2026, 2:00 AM3.9s1 file scanned
SKILL.md
- name:
- readme-guidelines
- description:
- Structurer un README utile. Utiliser quand on rédige ou met à jour la documentation du projet.
- risk:
- none
When to use
Activez cette compétence lors de la création d’un nouveau dépôt ou lorsque des changements importants justifient une mise à jour du README.
Instructions
- Commencez par un titre clair et une description succincte du projet.
- Détaillez les prérequis nécessaires à l’installation (versions de Node, variables d’environnement, accès aux services externes).
- Indiquez les étapes pour installer et exécuter le projet en local (commande d’installation des dépendances, lancement du serveur).
- Expliquez les scripts disponibles (test, lint, build, migration) et leur usage.
- Ajoutez des sections pour la configuration, la contribution (processus de PR), les licences et les contacts utiles.
- Mettez à jour le README dès que les procédures changent (nouvelles dépendances, modifications de commande).
Example
Le README d’un projet Node pourrait inclure :
npm cipour installer les dépendances.npm run devpour démarrer en mode développement.npm run testpour lancer les tests.- Une section décrivant les variables d’environnement à définir (
DATABASE_URL,JWT_SECRET).
Limitations
Le README doit rester concis et ne remplace pas une documentation détaillée pour les API ou l’architecture (voir les autres compétences).
Related Skills
FRmicrow/unit-testing-node
development
VerifiedTrustedCommunity
Écrire des tests unitaires Node.js. Utiliser quand on teste une fonction isolée avec Vitest dans backend/test/.
SKILL.mdUpdated Apr 16, 2026
FRmicrow/integration-testing
testing
VerifiedTrustedCommunity
Tester l'intégration entre services. Utiliser quand on vérifie l'interaction contrôleur/service avec Supertest + Vitest.
SKILL.mdUpdated Apr 16, 2026
FRmicrow/frontend-testing-react
development
VerifiedTrustedCommunity
Tester les composants React avec Vitest + Testing Library. Utiliser quand on teste le rendu ou les interactions.
SKILL.mdUpdated Apr 16, 2026
FRmicrow/e2e-testing-playwright
testing
VerifiedTrustedCommunity
Écrire des tests end-to-end Playwright. Utiliser quand on teste l'application complète du point de vue utilisateur.
SKILL.mdUpdated Apr 16, 2026