Skip to content

Latest commit

 

History

History
125 lines (60 loc) · 6.42 KB

CONTRIBUTING.md

File metadata and controls

125 lines (60 loc) · 6.42 KB

Comment contribuer au projet ?

(English version below)

Afin de pouvoir contribuer au projet, voici quelques éléments sur l'environnement projet sur Github, ainsi que les règles d'organisation mises en place.

Il y a plusieurs façons de contribuer, que l'on ai des compétences en développement ou non.

Première contribution ?

IMPORTANT : Avant de commencer à contribuer, assurer-vous de bien connaître Git & Github grâce aux documentations ici :

Bugs, évolutions, nouvelles fonctionnalités.

Avant tout, assurez-vous que le bug, la demande d'évolutions ou de nouvelle fonctionnalité, n'a pas déjà été signalé en effectuant une recherche sur GitHub dans la rubrique Issues.

Si vous ne parvenez pas à trouver une question ouverte traitant du problème, ouvrez une nouvelle issue, via le bouton New Issue.

Veillez à inclure un titre et une description claire, autant d'informations pertinentes que possible, ainsi qu'un exemple de code ou un scénario de test exécutable démontrant le comportement attendu qui ne se produit pas. Chaque issue est catégorisée selon un label cf. liste des labels.

Développer une nouvelle fonctionnalité ou corriger un bug

Pour développer une nouvelle fonctionnalité, procédé comme suivant :

  • Cloner ce dépôt via le bouton Fork présent sur l'interface, comme sur l'image ci-dessous. Cela va cloner ce projet dans un nouveau dépôt sur votre espace Github personnel.

  • Suivez la procédure de téléchargement & d'installation de ce nouveau dépôt décrite dans le fichier README.MD

  • Développez votre nouvelle fonctionnalité.

Vous avez écrit un patch ou développez une nouvelle fonctionnalité ?

Maintenant que votre nouvelle fonctionnalité (ou correction de bug) est prête, vous pouvez la soumettre pour vérification et ajout au dépôt principal du projet.

Pour faire cela, ouvrez une nouvelle demande d'ajout avec le bouton Create Pull request, comme sur l'image ci-dessous :

Avant de soumettre votre code, assurez-vous que la description décrit clairement le problème et la solution. Si cela correspond à une issue précédemment ouverte, incluez son numéro avec un #NuméroDeIssue .

À la suite de cette pull request, les développeurs/reviewers du projet principal évaluent le code proposé et l'impact sur l'évolution du projet avant de valider/rejeter/discuter la demande d'intégration de code.

La durée entre le moment où la pull request est envoyée, puis analysé par les reviewers, et validées/rejetées peut être très variable et nécessité un peu de patience :) .

Documentation

Les contributions ne concernent pas que le code. Il y a toujours un fort besoin de documentation, de tutoriels ou de vidéos dans l'utilisation des logiciels. Si vous souhaitez contribuer sur ces derniers n'hésitez pas à échanger sur les issues ou prendre contact pour proposer vos idées.

How to contribute to the project?

In order to be able to contribute to the project, here are some elements about the project environment on Github, as well as the organization rules set up.

There are several ways to contribute, whether you have development skills or not.

First contribution ?

IMPORTANT : Before starting to contribute, make sure you know Git & Github well thanks to the documentations here :

Bugs, evolutions, new features.

First of all, make sure that the bug, the request for evolutions or new functionality, has not already been reported by doing a search on GitHub in the Issues section.

If you can't find an open issue addressing the problem, open a new issue, via the New Issue button.

Be sure to include a clear title and description, as much relevant information as possible, and a code example or executable test case demonstrating the expected behavior that does not occur. Each issue is categorized by a label see list of labels.

Develop a new feature or fix a bug

To develop a new feature, proceed as follows:

  • Clone this repository via the Fork button present on the interface, as on the image below. This will clone this project into a new repository on your personal Github space.

  • Follow the procedure to download & install this new repository described in the README.MD file

  • Develop your new feature.

You have written a patch or developed a new feature?

Now that your new feature (or bug fix) is ready, you can submit it for verification and addition to the main project repository.

To do this, open a new pull request with the Create Pull request button, as in the image below:

Before submitting your code, make sure the description clearly describes the problem and the solution. If it matches a previously opened issue, include its number with a #OutcomeNumber.

Following the pull request, the developers/reviewers of the main project evaluate the proposed code and the impact on the project's progress before approving/rejecting/discussing the code integration request.

The length of time between the time the pull request is sent, then analyzed by the reviewers, and validated/rejected can be very variable and requires a little patience :) .

Documentation

Contributions are not only about code. There is always a strong need for documentation, tutorials or videos in the use of software. If you want to contribute on these do not hesitate to exchange on the issues or contact to propose your ideas.