Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (17 loc) · 2.35 KB

CONTRIBUTING.md

File metadata and controls

30 lines (17 loc) · 2.35 KB
Raw

Comment Contribuer

Nous sommes ravis que vous envisagiez de contribuer à Ressources et Aides en Informatique pour Ingénieurs (RAII)! Toutes les contributions sont les bienvenues : des corrections de fautes d'orthographe à de nouveaux contenus. En participant à ce projet, vous contribuez à créer une ressource précieuse pour les étudiants et les professionnels de l'informatique.

Comment Commencer

  1. Familiarisez-vous avec le dépôt. Prenez le temps de lire le README.md et de naviguer à travers les différentes sections pour comprendre la structure et le type de contenu disponible.

  2. Sélectionnez un sujet qui vous intéresse. Vous pouvez choisir de travailler sur un domaine technologique que vous maîtrisez ou sur des soft skills que vous souhaitez partager.

  3. Vérifiez les issues. Avant de commencer à travailler sur un ajout ou une modification, vérifiez les issues existantes pour éviter les doublons. Si votre contribution est grande et n'est pas encore référencée, il est une bonne idée de créer une nouvelle issue pour en discuter avec les autres avant de commencer à travailler.

Faire une Contribution

  1. Fork le dépôt. Cela vous permet de travailler librement sur votre projet sans affecter le dépôt principal.

  2. Créez une branche. Utilisez une branche spécifique pour votre contribution. Le nom de la branche devrait être descriptif, par exemple : ajout-tutoriel-docker ou correction-faute-frappe.

  3. Ajoutez vos contributions. Assurez-vous que votre contenu est clair, précis et respecte le style et la structure du dépôt. Pour les guides et tutoriels, incluez des exemples pratiques lorsque c'est possible.

  4. Soumettez une Pull Request (PR). Une fois votre contribution prête, soumettez une PR vers le dépôt principal. Dans votre PR, décrivez les changements apportés et référencez les issues correspondantes (si applicable).

Directives de Contenu

  • Clarté et Précision : Votre contribution doit être facile à comprendre et précise.
  • Originalité : Le contenu doit être original ou correctement attribué s'il s'agit de travaux dérivés.
  • Respect de la Structure : Votre contribution doit s'intégrer de manière cohérente dans la structure existante du dépôt.
  • Pas de Duplication : Vérifiez que votre contribution n'est pas déjà couverte.

Merci de contribuer !