Contribuer à l’Open Source sur GitHub¶
Avertissement
Cette section est librement adaptée de l’official GitHub guides.
Une excellente façon de s’impliquer dans l’open source est de contribuer aux projets existants que vous utilisez.
Une Structure typique de projet GitHub¶
La Communauté¶
Des projets ont souvent une communauté autour d’eux, composé d’autres utilisateurs dans des rôles différents (formelles ou informelles) :
Propriétaire est l’utilisateur ou organisation qui a créé le projet le projet a-t-il sur leur compte.
Maintainers et collaborateurs sont les utilisateurs principalement faire le travail sur un projet et la direction d’entraînement. Souvent, le propriétaire et le responsable sont les mêmes. Ils ont un accès en écriture au référentiel.
Contributeurs est tout le monde qui a eu une demande de traction fusionnée dans un projet.
Communauté membres sont les utilisateurs qui souvent utilisent et se soucient profondément le projet et sont actifs dans les discussions pour les fonctionnalités et tirez sur les requêtes.
Readme¶
Presque tous les projets de GitHub incluent un fichier de README.md. Le fichier readme fournit une configuration du terrain pour un projet avec des détails sur la façon de les utiliser, créer et parfois contribuer à un projet.
Licence¶
Un fichier LICENSE est la licence pour le projet. Une licence du projet open source informe les utilisateurs qu’ils peuvent et ne peuvent pas faire (par exemple, utiliser, modifier, redistribuer) et les contributeurs, qu’ils sont permettant à d’autres de le faire.
Documentation et Wikis¶
Beaucoup des projets fournissent plus que un readme pour donner des instructions pour comment les gens peuvent utiliser leur projet. Ils fournissent souvent un lien vers un autre fichier ou un dossier nommé docs dans le repository.
Alternativement, le référentiel peut utiliser le wiki de GitHub pour décomposer la documentation.
Issues¶
Les Issues sont une excellente façon de garder une trace de tâches, des améliorations et des bugs pour vos projets. Ils peuvent être partagés et discutés avec le reste de votre équipe. La plupart des projets de logiciel ont un traqueur de bug. Le traqueur de GitHub est tres simple et il est fourni par la section Issues.
Pour plus d’informations sur le fonctionnement des questions, consultez la section “Travailler avec GitHub Issues et Pull Requests“
Pull Requests¶
Si vous êtes capable de patcher un bogue ou ajouter une fonctionnalité vous-même, vous devez faire une une pull request avec le code sourc. Vous devez etre sure que vous avez lu tous les documents sur la contribution, que vous avez compri la licence et avez signé un CLA si nécessaire.
Une fois que vous avez soumis une demande de tirer les maintainer(s) pouvez comparer votre succursale à celle existante et décider ou non d’intégrer (traction) vos modifications.
Pour plus d’informations sur le fonctionnement de tirer les requêtes, reportez-vous à la section “Travailler avec GitHub Issues et Pull Requests“