Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

91 lines (58 loc) · 3.45 KB
Raw

Contribution Guidelines (English)

Contribution Guidelines

Thank you for considering contributing to our project! We welcome contributions from everyone, whether it's fixing a typo, adding new features, or improving documentation. Please take a moment to review this document before contributing to ensure a smooth and effective collaboration.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your forked repository locally.
  3. Create a new branch for your work.
  4. Make your changes and test thoroughly.
  5. Commit your changes with descriptive commit messages.
  6. Push your changes to your forked repository.
  7. Submit a pull request to the main repository.

Code Style

  • Follow the existing code style and conventions.
  • Use descriptive variable and function names.
  • Write clear and concise comments where necessary.
  • Keep code clean and organized.

Testing

  • Test your changes thoroughly to ensure they work as expected.
  • Write unit tests for new features and bug fixes if applicable.
  • Ensure existing tests pass before submitting a pull request.

Documentation

  • Update documentation to reflect your changes if necessary.
  • Improve existing documentation where possible.

Reporting Bugs

If you encounter a bug or issue, please open a new issue with a clear title and description. Include steps to reproduce the issue if possible.

Contact

If you have any questions or need further assistance, feel free to contact us.

Lignes Directrices de Contribution (Français)

Lignes Directrices de Contribution

Merci de considérer contribuer à notre projet ! Nous accueillons les contributions de tous, que ce soit pour corriger une faute de frappe, ajouter de nouvelles fonctionnalités ou améliorer la documentation. Veuillez prendre un moment pour consulter ce document avant de contribuer afin d'assurer une collaboration fluide et efficace.

Pour Commencer

  1. Forkez le dépôt sur GitHub.
  2. Clonez votre dépôt forké localement.
  3. Créez une nouvelle branche pour votre travail.
  4. Effectuez vos modifications et testez-les soigneusement.
  5. Commitez vos modifications avec des messages de commit descriptifs.
  6. Pushez vos modifications vers votre dépôt forké.
  7. Soumettez une pull request vers le dépôt principal.

Style de Code

  • Suivez le style de code et les conventions existants.
  • Utilisez des noms de variables et de fonctions descriptifs.
  • Écrivez des commentaires clairs et concis lorsque nécessaire.
  • Gardez le code propre et organisé.

Tests

  • Testez soigneusement vos modifications pour vous assurer qu'elles fonctionnent comme prévu.
  • Écrivez des tests unitaires pour les nouvelles fonctionnalités et les corrections de bugs si nécessaire.
  • Assurez-vous que les tests existants passent avant de soumettre une pull request.

Documentation

  • Mettez à jour la documentation pour refléter vos modifications si nécessaire.
  • Améliorez la documentation existante lorsque c'est possible.

Signalement de Bugs

Si vous rencontrez un bug ou un problème, veuillez ouvrir un nouvel issue avec un titre et une description clairs. Incluez les étapes pour reproduire le problème si possible.

Contact

Si vous avez des questions ou avez besoin d'aide supplémentaire, n'hésitez pas à nous contacter.