Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (42 loc) · 3.12 KB

CONTRIBUTING.md

File metadata and controls

59 lines (42 loc) · 3.12 KB

Guide de Contribution

Dépôt Officiel / Official Repository

Français : Le développement et la maintenance de ce projet se font exclusivement sur notre instance GitLab : https://gitlab.villejuif.fr/depots-public/gitlabmonitor.

C'est le seul endroit où les contributions (rapports de bugs, suggestions, requêtes de fusion) seront acceptées.

English: Development and maintenance of this project occur exclusively on our GitLab instance: https://gitlab.villejuif.fr/depots-public/gitlabmonitor.

This is the only place where contributions (bug reports, suggestions, merge requests) will be accepted.

Nous sommes ravis que vous envisagiez de contribuer à ce projet ! Toute contribution est la bienvenue, qu'il s'agisse de rapports de bugs, de suggestions de fonctionnalités ou de soumissions de code.

English version below

🇫🇷 Version Française

Comment Contribuer ?

  • Rapports de bugs : Si vous trouvez un bug, veuillez ouvrir une "Issue" en décrivant le problème le plus précisément possible. Incluez des étapes pour reproduire le bug, le résultat attendu et le résultat obtenu.
  • Suggestions de fonctionnalités : Ouvrez une "Issue" pour décrire votre idée. Expliquez pourquoi cette fonctionnalité serait utile.
  • Soumissions de code :
    1. Forkez le dépôt.
    2. Créez une nouvelle branche pour votre fonctionnalité ou votre correctif (git checkout -b feature/ma-super-feature ou fix/un-bug-agaçant).
    3. Faites vos modifications et commitez-les avec un message clair.
    4. Pushez votre branche (git push origin feature/ma-super-feature).
    5. Ouvrez une "Merge Request" (ou "Pull Request") vers la branche main du dépôt original.

Standards de Code

  • Style : Veuillez suivre le style de code existant. Pour les scripts shell, respectez les bonnes pratiques (variables en majuscules, fonctions claires, etc.).
  • Documentation : Si vous ajoutez une nouvelle fonctionnalité, mettez à jour le README.md en conséquence.

🇬🇧 English Version

How to Contribute?

  • Bug Reports: If you find a bug, please open an "Issue" describing the problem as precisely as possible. Include steps to reproduce the bug, the expected result, and the actual result.
  • Feature Suggestions: Open an "Issue" to describe your idea. Explain why this feature would be useful.
  • Code Submissions:
    1. Fork the repository.
    2. Create a new branch for your feature or fix (git checkout -b feature/my-awesome-feature or fix/an-annoying-bug).
    3. Make your changes and commit them with a clear message.
    4. Push your branch (git push origin feature/my-awesome-feature).
    5. Open a "Merge Request" (or "Pull Request") to the main branch of the original repository.

Code Standards

  • Style: Please follow the existing code style. For shell scripts, adhere to best practices (uppercase variables, clear functions, etc.).
  • Documentation: If you add a new feature, please update the README.md accordingly.