Contribuer

Nous accueillons les contributions à OpenEurOtop !

Comment contribuer

  1. Fork le repository

  2. Créer une branche pour votre feature

  3. Commiter vos changements

  4. Pousser vers votre fork

  5. Créer une Pull Request

Directives

Code

  • Suivre PEP 8

  • Documenter les fonctions (docstrings NumPy)

  • Ajouter des tests unitaires

  • Respecter la structure existante

Documentation

  • Utiliser le format NumPy pour les docstrings

  • Inclure des exemples d’utilisation

  • Référencer les sections EurOtop

Tests

Exécuter les tests :

python tests/test_overtopping.py
python tests/test_case_studies.py

Ajouter des tests pour toute nouvelle fonctionnalité.

Questions

Pour toute question, ouvrir une Issue sur GitHub.