Skip to content

Commit

Permalink
docs: issue forms, PR template, règles de contribution
Browse files Browse the repository at this point in the history
  • Loading branch information
slafayIGN committed Dec 14, 2023
1 parent d1a0764 commit 271c1c7
Show file tree
Hide file tree
Showing 8 changed files with 143 additions and 72 deletions.
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/1-signaler-une-anomalie.yml
Original file line number Diff line number Diff line change
@@ -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.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/2-demander-une-evolution.yaml
Original file line number Diff line number Diff line change
@@ -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...
Original file line number Diff line number Diff line change
@@ -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
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/demande-d--volution.md

This file was deleted.

10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/question.md

This file was deleted.

34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/rapport-d-anomalie.md

This file was deleted.

44 changes: 44 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<!--
Merci de participer par du code ou de la documentation à la vie de ce projet.
Nous apprécions votre travail.
Assurez-vous d'avoir lu le CONTRIBUTING.md de ce dépôt avant de proposer cette pull request.
Les commentaires de ce fichier peuvent être laissés inchangés. Ils n’apparaîtront pas dans la pull request.
-->

## Description

<!--
Décrivez brièvement les changements que vous proposez.
Écrivez de façon non technique si possible. Les relecteurs sont des humains.
- Si vous avez besoin de lier à une issue ou une autre pull request -> #
- Si vous avez besoin de mentionner des personnes -> @
-->

## Type de pull request

<!-- Cochez d'un x la ou les cases appropriées -->

- [ ] 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
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 271c1c7

Please sign in to comment.