Giters

sfeir-open-source / sfeir-school-modern-javascript

Modern Javascript Sfeir School. All about ESNext, Functional programming, Redux in JS

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[Feature Request] Ajout d'un guide de contribution

geromegrignon opened this issue · comments

commented

Description de la tâche

Ajout d'un guide de contribution pour guider les contributeurs pour :

  • la déclaration d'un bug
  • la demande d'une nouvelle fonctionnalité
  • les étapes pour soumettre une pull request
  • les attendus pour le format des messages de commit

Motivation

De par sa nature, la découverte d'un projet open-source se fait sans le soutien d'une phase d'onboarding active.
Il est donc nécessaire pour les mainteneurs d'un projet de proposer un moyen pour tout nouveau contributeur de comprendre les façon de communiquer et d'intéragir avec ce projet en autonomie.
En formalisant les échanges, cela permett aux mainteneurs d'être plus efficaces dans le traitement des demandes.

Le guide de contribution répond à ce besoin.

Reconnu par GitHub comme une source de documentation pour un contributeur, il est intégré dans le parcours utilisateur sur la plateforme pour s'assurer qu'il soit facilement accessible et reconnaissable.

Comment contribuer ?

Demander avant tout l'assignation de cette tâche en laissant un message dans cette issue afin d'éviter de multiplier les efforts sur une tâche unique!

Si la tâche est déjà assignée, vous pourrez trouver d'autres tâches ouvertes ici.

Après assignation, suivez les consignes suivantes :

  1. Récupérer le contenu du fichier markdown déjà présent dans le répertoire sfeir-school pwa.

  2. Suivre les indications de ce guide pour forker et cloner le répertoire présent.

  3. Y créer un fichier nommé CONTRIBUTING.md à la racine du projet et y coller le contenu.

  4. Modifier les liens en fin de fichier pour qu'ils pointent vers le bon projet.

[github]: https://github.com/sfeir-open-source/sfeir-school-angular
[github-issue]: https://github.com/sfeir-open-source/sfeir-school-angular/issues/new
[issue-tracker]: https://github.com/sfeir-open-source/sfeir-school-angular/issues
[github-pulls]: https://github.com/sfeir-open-source/sfeir-school-angular/pulls

Par exemple pour le sfeir-school React:

// Changer
[github]: https://github.com/sfeir-open-source/sfeir-school-angular

// en
[github]: https://github.com/sfeir-open-source/sfeir-school-react
  1. Suivre les étapes suivantes du guide de contribution pour pousser ce fichier sur GitHub et soumettre une pull request.