2.4 KiB

Raw Blame History

Contribuer au Projet

Merci de votre intérêt pour contribuer à ce projet ! Vos contributions sont essentielles pour améliorer ce dépôt de notes techniques. Voici quelques lignes directrices pour vous aider à démarrer.

Comment Contribuer

Fork le dépôt : Cliquez sur le bouton "Fork" en haut à droite de la page pour créer une copie de ce dépôt dans votre compte Git (GitHub, GitLab, Gitea ...).
Cloner votre fork : Clonez le dépôt forké sur votre machine locale.
```
git clone https://xxxx/votre-utilisateur/votre-repo.git
```
Créer une branche : Créez une nouvelle branche pour votre fonctionnalité ou correction.
```
git checkout -b ma-nouvelle-branche
```
Faire des modifications : Apportez vos modifications ou ajoutez de nouvelles notes techniques dans la structure de dossiers appropriée.
Commits : Faites des commits de vos modifications avec des messages clairs et concis.
```
git add .
git commit -m "Ajouter une nouvelle note sur [sujet]"
```
Pousser votre branche : Poussez votre branche vers votre dépôt forké.
```
git push origin ma-nouvelle-branche
```
Créer une Pull Request : Allez sur la page de votre dépôt forké et cliquez sur "New Pull Request". Décrivez vos modifications dans la description de la Pull Request.

Lignes Directrices pour les Contributions

Clarté et précision : Assurez-vous que vos notes sont claires, précises et faciles à suivre.
Formatage : Utilisez le format Markdown pour rédiger vos notes. Utilisez des titres, des sous-titres, des listes et du code formaté pour une meilleure lisibilité.
Consistance : Suivez le même style et les mêmes conventions que les autres notes du dépôt.
Licences et droits d'auteur : Assurez-vous que votre contribution n'enfreint aucun droit d'auteur. Mentionnez les sources si vous vous basez sur des travaux existants.

Suggestions et Discussions

Si vous avez des idées, des suggestions ou des questions, n'hésitez pas à ouvrir une issue. Nous encourageons les discussions et le brainstorming pour améliorer ce projet.

Code de Conduite

En contribuant à ce projet, vous acceptez de respecter notre Code de Conduite. Veuillez lire ce document pour comprendre les comportements que nous attendons et ceux que nous n'acceptons pas.

Merci de votre contribution !