diff --git a/.github/ISSUE_TEMPLATE/1-signaler-une-anomalie.yml b/.github/ISSUE_TEMPLATE/1-signaler-une-anomalie.yml new file mode 100644 index 0000000..82cedcd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/1-signaler-une-anomalie.yml @@ -0,0 +1,48 @@ +name: 🐛 Signaler une anomalie +description: Aidez nous à améliorer le validateur en complétant ce rapport d'anomalie +labels: [bug] +body: + - type: textarea + id: description + attributes: + label: Description + description: | + Une description claire et concise de l'anomalie rencontrée. + Ajoutez si possible des copies d'écran si cela peut aider à expliquer le problème. + validations: + required: true + - type: textarea + id: expected-behaviour + attributes: + label: Comportement attendu + description: Une description claire et concise du comportement que vous vous attendiez à rencontrer. + validations: + required: true + - type: textarea + id: how-to-reproduce + attributes: + label: Comment reproduire l'anomalie + description: | + Dans quelles conditions se produit l'anomalie : sur un ordinateur de bureau ou sur mobile ? Avec quel système d'exploitation ? Quel navigateur et version ou quel client REST ? + Etapes pour reproduire le comportement : + 1. Se rendre sur ... + 2. Cliquer sur ... + 3. Scroller jusqu'à ... + 4. Constater l'erreur ... + + Ajoutez des copies d'écran si nécessaire. + validations: + required: true + - type: textarea + id: possible-solution + attributes: + label: Solution possible + description: | + Optionnel : seulement si vous avez des suggestions pour corriger cette anomalie. + N'hésitez pas à créer une Pull Request pour avoir un retour plus direct. + - type: textarea + id: additional-context + attributes: + label: Complément de contexte + description: | + Optionnel : Ajoutez toute information qui vous semblerait utile pour nous aider à cerner cette anomalie. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/2-demander-une-evolution.yaml b/.github/ISSUE_TEMPLATE/2-demander-une-evolution.yaml new file mode 100644 index 0000000..c7828b9 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/2-demander-une-evolution.yaml @@ -0,0 +1,29 @@ +name: 🚀 Demander une évolution +description: Suggérer une idée d'évolution ou de nouvelle fonctionnalité pour le validateur +labels: [enhancement] +body: + - type: textarea + id: need-description + attributes: + label: Le besoin que vous rencontrez + description: | + Décrivez de façon claire et concise à quel besoin vous êtes confronté. + validations: + required: true + - type: textarea + id: possible-solution + attributes: + label: La solution que vous aimeriez + description: | + Décrivez précisément comment vous aimeriez que l'application ou la nouvelle fonctionnalité se comporte pour répondre à votre besoin. + - type: textarea + id: alternatives + attributes: + label: Les alternatives que vous avez considéré + description: Décrivez si possible les solutions alternatives que vous avez envisagé. Cela peut-être d'autres outils ou une fonctionnalité différente. + - type: textarea + id: additional-context + attributes: + label: Autres éléments de contexte + description: | + N'hésitez pas à ajouter tout élément de contexte qui vous semble utile pour aider l'équipe à mieux comprendre votre demande : copie d'écran, jeux de données... \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/3-demander-ou-proposer-de-la-documentation.yaml b/.github/ISSUE_TEMPLATE/3-demander-ou-proposer-de-la-documentation.yaml new file mode 100644 index 0000000..940eff8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/3-demander-ou-proposer-de-la-documentation.yaml @@ -0,0 +1,18 @@ +name: 📚 Demander ou proposer de la documentation +description: Posez une question sur une étape à éclaircir, suggérez des modifications de la documentation +labels: [documentation] +body: + - type: textarea + id: description + attributes: + label: Description + description: | + Posez une question ou proposez des modifications de la documentation. + Détaillez votre besoin ou votre idée au maximum. + + Les ajouts ou modifications peuvent être : + * des ajouts ou modifications d'aide contextuelle (aide accompagnant un champ du formulaire par exemple) + * des ajouts dans la documentation swagger de l'API + * à tout autre endroit où vous les trouveriez judicieux + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/demande-d--volution.md b/.github/ISSUE_TEMPLATE/demande-d--volution.md deleted file mode 100644 index 37b8255..0000000 --- a/.github/ISSUE_TEMPLATE/demande-d--volution.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Demande d'évolution -about: Suggérez une idée d'évolution ou de nouvelle fonctionnalité -title: '' -labels: enhancement -assignees: '' - ---- - -**Le besoin que vous rencontrez** - -Décrivez de façon claire et concise à quel besoin vous êtes confronté. - -**La solution que vous aimeriez** - -Décrivez précisément comment vous aimeriez que l'application ou la nouvelle fonctionnalité se comporte pour répondre à votre besoin. - -**Les alternatives que vous avez considéré** - -Décrivez si possible les solutions alternatives que vous avez envisagé. Cela peut-être d'autres outils ou une fonctionnalité différente. - -**Autres éléments de contexte** - -N'hésitez pas à ajouter tout élément de contexte qui vous semble utile pour aider l'équipe à mieux comprendre votre demande : copie d'écran, jeux de données... diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 3b07aff..0000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Question -about: Posez une question sur le projet -title: '' -labels: '' -assignees: '' - ---- - -# Question diff --git a/.github/ISSUE_TEMPLATE/rapport-d-anomalie.md b/.github/ISSUE_TEMPLATE/rapport-d-anomalie.md deleted file mode 100644 index 6a92568..0000000 --- a/.github/ISSUE_TEMPLATE/rapport-d-anomalie.md +++ /dev/null @@ -1,34 +0,0 @@ ---- -name: Rapport d'anomalie -about: Aidez nous à améliorer le validateur en complétant ce rapport d'anomalie -title: '' -labels: bug -assignees: '' - ---- - -**Description de l'anomalie** - -Décrivez de façon claire et concise l'anomalie que vous rencontrez avec le validateur. - -**Etapes pour reproduire** - -Décrivez pas à pas comment reproduire ce comportement : - -1. Aller à '...' -2. Cliquer sur '....' -3. Scroller jusqu'à '....' -4. Consultez la console du navigateur - -**Comportement attendu** - -Décrivez de façon claire et concise ce que devrait être selon vous un comportement normal de l'application. - -**Copies d'écran** - -Si vous le pouvez et si c'est pertinent, ajoutez des copies d'écran de l'anomalie. - -**Autres informations de contexte** - -Décrivez si nécessaire les logiciels utilisés : OS, navigateur ou client REST... -Ajoutez toute autre information de contexte sur le problème que vous jugez pertinente. Par exemple le lien vers un jeu de données. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..8b02ae6 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,44 @@ + + +## Description + + + +## Type de pull request + + + +- [ ] correction de bug +- [ ] nouvelle fonctionnalité +- [ ] mise à jour de dépendance +- [ ] mise à jour du style (formatage, renommage) +- [ ] refactoring (pas de changement fonctionnel) +- [ ] changement lié au build +- [ ] contenu de la documentation +- [ ] autre changement (détaillez ici) +- [ ] je ne suis pas sûr + +## Est-ce que vous introduisez des changements cassants ? + +- [ ] Oui +- [ ] Non +- [ ] Je ne suis pas sûr (nous allons vérifier) + +## Checklist + +- [ ] Je comprends et accepte que les changements dans cette PR seront sous [licence AGPL 3](../LICENSE) +- [ ] J'ai suivi les [règles de contribution](../CONTRIBUTING.md), notamment en ce qui concerne le numéro de version de l'API +- [ ] J'ai mis à jour les tests et la documentation et les tests passent en local diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e01c83..b09a3a3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,17 @@ # Contribuer -Merci d'envisager nous aider sur ce projet. Tout type de contribution est bienvenue +Merci d'envisager nous aider sur ce projet. Tout type de contribution est bienvenue. ## Contributions autres que du code N'hésitez pas à formuler toute proposition de nouvelle fonctionnalité, signalement d'anomalie ou même question dans une [nouvelle issue](https://github.com/IGNF/validator-api/issues/new/choose). -Vous pouvez également parcourir les [issues existantes](https://github.com/IGNF/validator-api/issues) pour voir si le sujet n'a pas déjà été abordé. +Vous pouvez également parcourir les [issues existantes](https://github.com/IGNF/validator-api/issues) 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é quel 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 : +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-api](https://github.com/IGNF/validator-api) : la surcouche API REST en PHP (le présent dépôt) * [IGNF/validator](https://github.com/IGNF/validator) : le moteur de validation en Java +* [IGNF/validator-api](https://github.com/IGNF/validator-api) : la surcouche API REST en PHP (le présent dépôt) * [IGNF/validator-api-client](https://github.com/IGNF/validator-api-client/) : l'interface graphique du démonstrateur ## Modifier le code ou la documentation