Skip to content

Commit

Permalink
add bug report and feature request section in the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
khansadaoudi committed Nov 14, 2023
1 parent e819d5a commit 269d8d7
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 0 deletions.
1 change: 1 addition & 0 deletions _sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* [**Github Synchronization**](githubSync.md)
* [**Parser**](parser.md)
* [**Blind Annotation**](blindAnnotation.md)
* [**Bug Report/Feature request**](bugReport.md)



Expand Down
30 changes: 30 additions & 0 deletions bugReport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Bug reports and feature requests

We value your feedback and we encourage you to share your ideas, report bugs or suggest new features. Your contributions are essential in helping us improve our tool and offer a better user experience.

### Bug reports
If you notice a problem or unusual behavior when using our tool, please take the time to report it. Your bug reports are important in helping us to detect and resolve problems more effectively.
Follow these steps to submit a bug report:

- Check if this bug has already been submited in the [issues page](https://github.com/Arborator/arborator-frontend/issues).
- Choose bug report template for [issue templates](https://github.com/Arborator/arborator-frontend/issues/new/choose)
- Provide detailed Information
- Clear description of the current behaviour.
- Steps to follow to reproduce the bug.
- Project name if the problem concerns your data.
- Attachements, screenshots to give more context on the bug.
- Any other relevant information.

### Feature requests

If you have any suggestions that could improve the user experience or enhance ArboratorGrew, feel free to submit a feature request. Follow the steps given below to submit a feature request:

- Check the similar feature requests.
- Describe the problem to be solved in this feature request.
- Provide concise description of the solution.






1 change: 1 addition & 0 deletions fr/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* [**Synchronisation avec Github**](/fr/githubSync.md)
* [**Parseur**](/fr/parser.md)
* [**Annotation à l'Aveugle**](/fr/blindAnnotation.md)
* [**Rapport de bogue / Proposition de fonctionnalité**](/fr/bugReport.md)



Expand Down
30 changes: 30 additions & 0 deletions fr/bugReport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Rapports de bogues et Propositions de fonctionnalités

Nous apprécions vos retours et nous vous encourageons à partager vos idées, à signaler des bogues ou à suggérer de nouvelles fonctionnalités. Vos contributions sont essentielles pour nous aider à améliorer notre outil et à offrir une meilleure expérience aux utilisateurs.

### Rapport de bogues
Si vous remarquez un problème ou un comportement inhabituel lors de l'utilisation de notre outil, prenez le temps de le signaler. Vos rapports de bogues sont importants car ils nous aident à détecter et à résoudre les problèmes plus efficacement.
Suivez les étapes suivantes pour soumettre un rapport de bogue :

- Vérifier si ce bogue a déjà été soumis dans [la page des issues](https://github.com/Arborator/arborator-frontend/issues).
- Choisir le modèle de rapport de bogue à partir [les modèles des issues](https://github.com/Arborator/arborator-frontend/issues/new/choose)
- Fournir des informations détaillées
- Description claire du comportement actuel.
- Étapes à suivre pour reproduire le bogue.
- Nom du projet si le problème concerne vos données.
- Pièces jointes, captures d'écran pour donner plus de contexte au bogue.
- Toute autre information pertinente.

### Propositions de fonctionalités

Si vous avez des suggestions qui pourraient améliorer l'expérience utilisateur ou le développement d'ArboratorGrew, n'hésitez pas à soumettre vos propositions. Suivez les étapes ci-dessous pour soumettre une proposition de fonctionnalité :

- Vérifiez les propositions similaires.
- Décrivez le problème à résoudre dans cette proposition.
- Fournissez une description concise de la solution.






2 changes: 2 additions & 0 deletions home.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ creating, updating, maintaining, and curating syntactic treebanks and semantic g
> **[ArboratorGrew](https://arboratorgrew.elizia.net/#/)** is adapted better to
**[UD Universal Dependencies](https://universaldependencies.org/)** (Treebank annotation grammar) and **[SUD Surface Syntactic Universal Dependencies](https://surfacesyntacticud.github.io/)** (Distribution based version of UD).

>



Expand Down

0 comments on commit 269d8d7

Please sign in to comment.