147 lines
6.3 KiB
Plaintext
147 lines
6.3 KiB
Plaintext
---
|
|
sidebar_position: 99999
|
|
description: "Tu souhaites contribuer à Memento Dev ? C'est par ici !"
|
|
---
|
|
|
|
# 🤝 Contribuer
|
|
|
|
## 👋 Avant toute chose
|
|
|
|
**Memento Dev** est, à l'instar du [**MDN Web Docs**](https://developer.mozilla.org/en-US/) 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](https://github.com/preparation-tp/memento-dev/issues) 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](https://mdxjs.com/),
|
|
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](https://github.com) ;
|
|
- L'utilitaire [Git](https://git-scm.com/) installé sur votre machine ;
|
|
- [Node.js](https://nodejs.org/) et [npm](https://www.npmjs.com/) pour lancer le serveur de développement.
|
|
|
|
## 🚀 Comment contribuer ?
|
|
|
|
1. Faites un fork du projet
|
|
- [🔗 Documentation Github](https://docs.github.com/fr/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
|
|
2. Clonez le projet sur votre machine
|
|
- [🔗 Documentation Github](https://docs.github.com/fr/repositories/creating-and-managing-repositories/cloning-a-repository)
|
|
3. Créez une branche pour votre contribution
|
|
- [🔗 Documentation Github](https://github.com/git-guides#create-a-branch)
|
|
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
|
|
- [🔗 Documentation Github](https://github.com/git-guides/git-push)
|
|
7. Créez une pull request
|
|
- [🔗 Documentation Github](https://docs.github.com/fr/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
|
|
- [🔗 Pull requests du repository Memento Dev](https://github.com/preparation-tp/memento-dev/pulls)
|
|
|
|
## ✍️ 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](https://www.conventionalcommits.org/en/v1.0.0/).
|
|
|
|
### 📝 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](https://opensource.org/license/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. |