Skip to content

Latest commit

 

History

History
79 lines (60 loc) · 4.96 KB

CONTRIBUTING.md

File metadata and controls

79 lines (60 loc) · 4.96 KB
Raw

Lignes directrices pour contribuer

Les pull requests, signalements de bug et toutes autres formes de contribution sont les bienvenues et hautement recommendées!

Ce guide a pour but de donner des normes pour l'ensemble du projet afin de le rendre plus simple à lire et contribuer

📖 Code de conduite

Merci de lire notre Code de conduite pour assurer un moment convivial à tous les contributeurs

❗ TOUTE UTILISATION DE CHATGPT OU AUTRE SERA BANNIE DU PROJET

📥 Ouvrir une Issue

Avant de créer une issue, soyez sûr d'avoir la version la plus récente du plugin

🪲 Signalement de bugs et autres problèmes

La meilleure façon de contribuer sans coder est de partager les bugs Si vous en rencontrez un, nous apprécierons un rapport bien écrit ❤️

Avant d'envoyer un ticket soyez sûr de:

  • Ne pas avoir créé un doublon !
  • Utiliser des réactions, si vous rencontrez le même problème qu'un ticket existant, utilisez une réaction 👍 au lieu d'écrire un commentaire (sauf si votre commentaire ajoute des détails)
  • Remplire completement le template, le template a été écrit pour simplifier le travail des contributeurs, merci de leurs faciliter la vie

🔁 Envoyer une Pull Request

Avant de forker le repo et créer une pull request, assurez vous que les modifications que vous souhaitez apporter ne sont pas déjà en cours de développement. Dans ce cas, voyez avec le premier auteur pour collaborer !

Note: Toutes les contributions auront la license GPL 3.0

  • Plus petit, mieux c'est. Envoyer une seule pull request par bugfix ou fonctionnalité, - Ne pas changer du code qui n'est pas lié à votre changement, C'est mieux de faire plein de petites PR plutot qu'une grande, Les grandes pull requests mettent du temps à être approuvées et peuvent être rejettées pour cette raison.
  • Soyez coordonnés, pour éviter de travailler sur la même chose en parallèle coordonnez vous (en publique) sur qui écrit quoi
  • Suivez les conventions de code existantes, suivre les conventions permet d'avoir un code plus facile à lire et à corriger
  • Corriger tous les conflits
  • Quand vous écrivez des commentaires, écrivez des phrases construites, sans argot

Il est préférable qu'une PR sois merge par quelqu'un d'autre que son auteur Avant de merge je m'assure que le code se compile et s'éxécute sans problèmes, ni erreur

📝 Ecrire un message de commit

S'il vous plaît, écrivez de bons messages de commits

  1. Limitez le sujet à 50 charactères
  2. Utilsez l'imperatif (example: "Corrige un bug avec les pommes")
  3. Ajoutez un tag si possible ([Docs], [Bug], [Features]...)
  4. Ecrivez des descriptions complètes
  5. Ne dépassez pas les 72 charactères en largeur

aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa (72 chars)

[BUG] Corrige le bug avec les pommes

Ecrivez une description complète, séparez les paragraphes par une
ligne blanche, expliquez le problème, avec du contexte si nécessaire,
focusez-vous sur comment vous l'avez résolu, l'objectif est d'écrire
un patch que les reviewers et le futur vous pourrez lire et expliquer

Notez les issues qui sont résolues via ce patch
Résous: #123
Voir aussi: #456, #789

✅ Examiner le code

  • Examinez le code, pas l'auteur, Donnez des critiques constructives

💅 Style de code

Les noms doivent être en anglais, peu importe la chose nommée.

Chose nommée Règle Exemple
Composants PascalCase pour les noms de fichiers et les noms de composants. Utilisez des noms descriptifs. UseProfile.vue NavigationBar.vue
Page kebab-case pour les noms de fichiers. Ils correspondent aux routes. user-settings.vue, about.vue
Plugins camelCase pour les noms de fichiers. axios.js, vueAuthentication.js
Middleware kebab-case pour les noms de fichiers. auth-check.js, locale-redirect.js
Store (Vuex) camelCase pour les noms de fichiers et les noms de modules. user.js, shoppingCart.js
Layouts kebab-case pour les noms de fichiers, PascalCase pour les noms de composants. default.vue, admin-layout.vue
Méthodes camelCase. Commencez par un verbe. getData(), updateUser()
Propriétés de composants camelCase. Noms descriptifs. userName, isLoading
Props camelCase dans la définition, kebab-case dans les templates. props: ['itemId'], <ComponentName :item-id="123" />
Événements personnalisés kebab-case this.$emit('user-logged-in')
Constantes UPPER_SNAKE_CASE const MAX_ITEMS_PER_PAGE = 20