Aller au contenu principal

🤝 Contribuer

👋 Avant toute chose​

Memento Dev est, à l'instar du MDN Web Docs et feu Le Site du Zéro, une ressourcerie en ligne destinée aux développeuses et développeurs (de près comme de loin).
Notre objectif est simple : partager de courts guides qui synthétisent les concepts, les bonnes pratiques et les outils du développement web.

L'idée n'est pas de réinventer la roue ni de proposer une énième école en ligne.
Le partage et l'entraide sont les maîtres-mots de ce projet ❤️

Si toi aussi tu souhaites partager tes connaissances, tes astuces et pourquoi pas tes erreurs, tu es le bienvenu !

📝 Comment contribuer ?​

De manière générale, tu peux contribuer de plusieurs manières :

  • en proposant des corrections ou des améliorations sur les contenus existants ;
  • en rédigeant de nouveaux guides ;
  • en proposant des idées de guides ;
  • en partageant des ressources utiles ;
  • en signalant des erreurs ou des liens morts.

📜 Directives de rédaction​

Cette ressourcerie n'est pas un lieu de débat ni un espace publicitaire.
Il est par conséquent important de respecter les règles suivantes :

  • Soyez concis : les guides doivent être courts et aller à l'essentiel ;
  • Soyez clair : évitez le jargon et les termes techniques inutiles (ou expliquez-les) ;
  • Soyez précis : vérifiez vos sources et vos informations ;
  • Soyez pédagogue : expliquez les concepts comme si vous vous adressiez à un enfant de 10 ans (sans le prendre pour un idiot) ;
  • Soyez bienveillant : les erreurs sont humaines, ne soyez pas agressif en cas de correction.
  • Soyez ouvert : les contributions sont ouvertes à tous, sans distinction de niveau ou d'expérience.

En ce qui concerne la rédaction des guides, vous pouvez vous inspirer des guides existants.
Le ton employé se veut simple, direct et amical.

Si vous remarquez un contenu qui ne respecte pas les règles mentionnées plus bas, merci de le signaler en ouvrant une issue en précisant la page concernée.

❌ Sujets interdits​

Certains sujets sont formellement interdits dans n'importe quelle page de ce site :

  • la politique ;
  • la religion ;
  • la pornographie ;
  • la violence ;
  • le racisme ;
  • le sexisme ;
  • l'homophobie ;
  • la transphobie ;
  • la xénophobie ;
  • la discrimination ;
  • la publicité ;
  • les contenus illégaux.

❌ Termes interdits​

L'emploi de certains termes considérés comme étant péjoratifs pour parler d'une personne sont également à proscrire :

  • son milieu ;
  • son origine ;
  • son genre ;
  • son identité de genre ou l'expression de son genre ;
  • son orientation sexuelle ;
  • son handicap ;
  • son âge ;
  • son apparence physique ;
  • sa situation de famille ;
  • sa religion ;
  • sa situation géographique ;
  • autres attributs personnels.

📦 Prérequis​

L'intégralité du contenu de ce site est rédigé en MDX, un mélange de Markdown et de JSX. Des connaissances basiques en Markdown sont donc nécessaires.

Pour contribuer, vous aurez besoin de :

  • Un éditeur de texte ou de code (Visual Studio Code, Sublime Text, Atom, etc.) ;
  • Un navigateur web (Chrome, Firefox, Edge, etc.).
  • Un compte Github ;
  • L'utilitaire Git installé sur votre machine ;
  • Node.js et npm pour lancer le serveur de développement.

🚀 Comment contribuer ?​

  1. Faites un fork du projet
  2. Clonez le projet sur votre machine
  3. Créez une branche pour votre contribution
  4. Faites vos modifications
  5. Testez vos modifications en local
    • npm install pour installer les dépendances
    • npm start pour lancer le serveur de développement
  6. Poussez vos modifications sur votre fork
  7. Créez une pull request

✍️ Convention de nommage​

📁 Git​

L'intégralité des commits et branches doit être rédigée en anglais.
Ces dernières se basent sur la convention Conventional Commits.

📝 Fichiers et dossiers​

Les fichiers et dossiers pour la documentation et les assets doivent être nommés en anglais et en kebab-case, sans caractères spéciaux ni espaces.

Les fichiers et dossiers pour les composants React (hors pages) doivent être nommés en anglais et en PascalCase.

©️ Licence​

La documentation de ce projet est sous licence MIT.
Cette licence permet à quiconque de réutiliser les contenus de ce site à des fins commerciales, sans restriction.

🔓 Cession de droits​

En contribuant à ce projet, vous autorisez le site Memento Dev à utiliser votre contenu sous licence MIT.
Aucun droit d'auteur ne peut être réclamé sur vos contributions.

Memento Dev s'engage à ne pas se considérer comme l'auteur ou unique propriétaire de vos contributions.
Memento Dev sert uniquement de support pour la publication des différentes contributions.

Il est important de noter que les contributions sont publiques et que tout le monde peut les consulter, tout comme l'historique des modifications.

🫶 Réutilisation des contenus​

Bien qu'aucune autorisation ne soit nécessaire pour réutiliser les contenus de ce site, nous appréciions tout de même que vous mentionniez la source originale et la liste des contributeurs figurant sur la page de chaque guide.

Par respect et solidarité envers les contributeurs, merci de ne pas copier-coller les contenus sans en mentionner la source.