Merci d'envisager nous aider sur ce projet. Tout type de contribution est bienvenue.
N'hésitez pas à formuler toute proposition de nouvelle fonctionnalité, signalement d'anomalie ou même question dans une nouvelle issue.
Vous pouvez également parcourir les issues existantes pour voir si le sujet n'a pas déjà été abordé et apporter des informations complémentaires ou proposer des pistes de solutions.
Enfin si vous pensez avoir cerné quelle partie du validateur est concernée par votre contribution, vous pouvez créer l'issue dans le dépôt qui est le plus approprié parmi :
- IGNF/validator : le moteur de validation en Java
- IGNF/validator-api : la surcouche API REST en PHP (le présent dépôt)
- IGNF/validator-api-client : l'interface graphique du démonstrateur
Si vous voulez corriger une anomalie ou apporter une nouvelle fonctionnalité vous-même, faites ces modifications dans un fork du dépôt et soumettez-nous une pull request
Consultez la documentation développeur pour prendre en main ce dépôt.
Attention, nous utilisons commitlint pour s'assurer que les messages de commit restent cohérents, avec l'objectif futur d'automatiser la publication de nouvelles release. Les règles à suivre pour les messages de commit sont celles de semantic-release
La première ligne des messages de commit doit se présenter sous la forme :
<type>(<scope>): <subject>
<type> est à choisir parmi une liste définie dans .commitlintrc.json. <subject> est un résumé de la modification. <scope> est optionnel.
Exemple :
feat: ajout export CSV des rapports de validation
- Consulter le numéro de la dernière version.
- Renseigner la future version dans docs/specs/validator-api.yml (ex :
info.version: 0.3.0) - Créer et pousser un tag (ex :
v0.3.0) - Créer une release à partir du tag (voir https://github.com/IGNF/validator-api/tags)