From 61c986abfa4b8a02330b70028caf06225ef64cbf Mon Sep 17 00:00:00 2001 From: Sylvain Lafay Date: Fri, 8 Dec 2023 10:48:18 +0100 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20issue=20forms,=20PR=20template,=20r?= =?UTF-8?q?=C3=A8gles=20de=20contribution?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../1-signaler-une-anomalie.yml | 48 +++++++++++++++++++ .../2-demander-une-evolution.yaml | 29 +++++++++++ ...ander-ou-proposer-de-la-documentation.yaml | 18 +++++++ .github/ISSUE_TEMPLATE/demande-d--volution.md | 24 ---------- .github/ISSUE_TEMPLATE/question.md | 10 ---- .github/ISSUE_TEMPLATE/rapport-d-anomalie.md | 34 ------------- .github/pull_request_template.md | 44 +++++++++++++++++ CONTRIBUTING.md | 8 ++-- 8 files changed, 143 insertions(+), 72 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/1-signaler-une-anomalie.yml create mode 100644 .github/ISSUE_TEMPLATE/2-demander-une-evolution.yaml create mode 100644 .github/ISSUE_TEMPLATE/3-demander-ou-proposer-de-la-documentation.yaml delete mode 100644 .github/ISSUE_TEMPLATE/demande-d--volution.md delete mode 100644 .github/ISSUE_TEMPLATE/question.md delete mode 100644 .github/ISSUE_TEMPLATE/rapport-d-anomalie.md create mode 100644 .github/pull_request_template.md 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 From 3f691cc6dad61156d261a81eb89be3fdbd9b3a6c Mon Sep 17 00:00:00 2001 From: Sylvain Lafay Date: Thu, 14 Dec 2023 11:07:36 +0100 Subject: [PATCH 2/2] =?UTF-8?q?docs:=20compl=C3=A9ments=20suite=20review?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/2-demander-une-evolution.yaml | 3 ++- .../3-demander-ou-proposer-de-la-documentation.yaml | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/2-demander-une-evolution.yaml b/.github/ISSUE_TEMPLATE/2-demander-une-evolution.yaml index c7828b9..76ffe49 100644 --- a/.github/ISSUE_TEMPLATE/2-demander-une-evolution.yaml +++ b/.github/ISSUE_TEMPLATE/2-demander-une-evolution.yaml @@ -1,5 +1,5 @@ name: 🚀 Demander une Ă©volution -description: SuggĂ©rer une idĂ©e d'Ă©volution ou de nouvelle fonctionnalitĂ© pour le validateur +description: SuggĂ©rez une idĂ©e d'Ă©volution ou une nouvelle fonctionnalitĂ© pour le validateur labels: [enhancement] body: - type: textarea @@ -8,6 +8,7 @@ body: label: Le besoin que vous rencontrez description: | DĂ©crivez de façon claire et concise Ă  quel besoin vous ĂȘtes confrontĂ©. + Par exemple : "Je souhaite pouvoir valider mes donnĂ©es dans le systĂšme de coordonnĂ©es EPSG:3128" validations: required: true - type: textarea 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 index 940eff8..8155e63 100644 --- a/.github/ISSUE_TEMPLATE/3-demander-ou-proposer-de-la-documentation.yaml +++ b/.github/ISSUE_TEMPLATE/3-demander-ou-proposer-de-la-documentation.yaml @@ -8,6 +8,7 @@ body: label: Description description: | Posez une question ou proposez des modifications de la documentation. + Alertez nous sur un parcours qui vous aurait semblĂ© difficile. DĂ©taillez votre besoin ou votre idĂ©e au maximum. Les ajouts ou modifications peuvent ĂȘtre :