Skip to main content

Guide de contribution

Si vous souhaitez contribuer au code source ou à la documentation de necord, n'hésitez pas à forker le dépôt et à soumettre une pull request. Nous utilisons ESLint pour imposer un style de code cohérent, donc le configurer dans l'éditeur de votre choix réduit les frictions lors de la contribution à ce projet.

Configuration​

Vous aurez besoin de Node.js version 18+, et de npm.

Pour vous préparer à travailler sur le code source, veuillez procéder comme suit :

  1. Forkez et clonez le dépôt. Assurez-vous d'être à jour avec la branche master !
  2. Installez les dépendances en utilisant yarn install ou npm install
  3. Codez à cœur joie !
  4. Exécutez yarn lint pour lancer ESLint et vous assurer que les modifications respectent notre guide de style
  5. Soumettez une pull request (Assurez-vous de suivre le format de commit conventionnel)

Un aperçu général des outils utilisés :

Contribuer à la documentation​

Si vous souhaitez contribuer à la documentation, vous pouvez le faire en modifiant les fichiers du dépôt docs. La documentation est rédigée en Markdown, vous pouvez donc utiliser n'importe quel éditeur Markdown pour apporter des modifications. Utilisez yarn dev pour démarrer un serveur local et prévisualiser vos modifications.

Avant de soumettre une pull request, veuillez vous assurer que :

  • Utilisez Markdown pour le formatage
  • Utilisez MDX pour intégrer des composants React
  • Utilisez GitHub Flavored Markdown pour les blocs de code
  • Utilisez des liens d'ancrage pour les liens internes (par ex. #contributing-to-documentation)

Contributeurs​

Contributors