CONTRIBUTING.md

Contributing

(Français)

How to Contribute

Aside from directly adding code to the repository, you can also join the discussion on current issues or contribute by proposing changes.

Join the discussion

Peruse the Issues and see what bug reports, fixes, proposed featurs are being discussed. You can help verify problems, support certain features, or discuss solutions.

Proposing changes

Is there a feature you'd like to see? You can let us know by first checking if it's been proposed in our Issues and if it hasn't, create a new Issue about it!

Reporting bugs

Do not post any security issues on the public repository! See SECURITY.md. If you spot a bug, check if it's already been identified under Issues. If it hasn't been reported, open a new issue.

Contributing your code

Do you want to submit any code changes or fixes?

1. Let us know by creating an Issue (see above) or comment on an existing Issue. We constantly monitor the Issues and once it's confirmed, we will create a branch in repository for this Issue (e.g. issue-26).

2. Create a fork of the repository (with the new branch).

3. Code your changes. Certain modifications/reports are auto-generated when the server is deployed, be aware of what code changes you authored and only commit those that are relevant. See our wiki for more information.

4. Sync your branch with our main branch (to ensure your branch is up to date).

5. Test your code using the testing environment; you may need to edit existing tests and/or create your own tests.

6. Create a pull request to our repository's issue branch (e.g. issue-26).

7. We will pull your changes and eventually merge it with our main branch once your contributions are reviewed and accepted for inclusion.

   If this is your first time contributing on GitHub/GitLab, don't worry! Let us know if you have any questions.

---

Comment contribuer

Outre l'ajout direct de code au référentiel, vous pouvez également contribuer en proposant-des-modifications ou en rejoignant les discussions sur les problèmes en cours.

Rejoindre la discussion

Parcourez les "Issues" et voyez quels rapports de bogues, correctifs, fonctionnalités proposées font l'objet de discussions. Vous pouvez aider à vérifier les problèmes, soutenir certaines fonctionnalités ou discuter des solutions.

Proposer des changements

Y a-t-il une fonctionnalité que vous aimeriez voir dans notre référentiel ? Vérifiez si elle a été proposée dans nos "Issues". Si elle n'existe pas encore, créez un problème à ce sujet !

Signalement des bugs

Ne publiez pas de problèmes de sécurité sur le dépôt public! Voir SECURITY.md Si vous repérez un bogue, vérifiez s'il a déjà été identifié dans la rubrique "Issues". S'il n'a pas été signalé, ouvrez un nouveau "problème".

Soumission de vos modifications ou corrections

Souhaitez-vous soumettre des modifications ou des correctifs de code ?

1. Faites-le nous savoir en créant un problème (voir ci-dessus) ou en commentant un problème existant. Nous créerons une 'branche' nommée en fonction du problème (par exemple, issue-26).

2. Créez un "fork" du référentiel (avec la branche nouvellement créée).

3. Codez vos changements. Certaines modifications/rapports sont générés automatiquement lorsque le serveur est déployé, soyez conscient des changements de code que vous avez créés et ne "commit" que ceux qui sont pertinents. Consultez notre wiki pour plus d'informations.

4. Synchronisez votre "branche" avec notre branche principale (pour vous assurer que votre "branche" est à jour.

5. Testez votre code à l'aide de l'environnement de test vous devrez peut-être modifier des tests existants et/ou créer vos propres tests

6. Créez une "pull request" vers la "branche" de notre dépôt (par exemple, issue-26).

7. Nous retirerons vos modifications et les fusionnerons éventuellement avec notre branche principale une fois que vos contributions auront été examinées et acceptées pour inclusion.

   Si c'est la première fois que vous contribuez à GitHub, ne vous en faites pas! Faites-nous part de vos questions.