GUIDELINES

[nesimer]

Issue by millehorde Friday Jan 11, 2019 at 00:23 GMT Originally opened as https://github.com/millehorde/BlogSpec/issues/59

---

Liste des bonnes pratiques à utiliser avec le projet et NestJS:

• Faire attention à la responsabilité de chaque méthode et chaque fichier, si trop volumineux => splitter 🤓
• 1 module = 1 dossier 📁
• 💣 1 méthode = au moins 1 test unitaire
• ⚠️ 1 route (endpoint) = au moins 1 test End2End
• Dans les providers, documentez toutes vos méthodes classes en suivant la nomenclature de la JsDoc 👊
• Pour les controllers, utilisez le plus possible les decorateurs @Api...() pour générer une documentation swagger toute faite
• Un code clair, c'est un code maintenable et lisible
• Pas de as any ou de : any en dehors de tests, typez tout ce que vous faites !