Commit 347fab73 authored by Halunka Matthieu's avatar Halunka Matthieu
Browse files

Adding templates and contributing guide

parent b2074a3e
# Issue basique
<!--
Nous vous remercions de contribuer à ce projet par la création de cette issue !
Pour éviter les duplicats, nous vous demandons de cocher les cases dans la liste qui suit.
-->
<!-- Cocher une case doit ressembler à ceci : [x] -->
- [ ] Cette issue est présente dans la dernière version livrée.
- [ ] J'ai cherché dans les [issues](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/issues) de ce répertoire et crois que ceci n'est pas un duplicat.
## Contexte 🔦
<!--
Qu'essayez vous d'accomplir ? Comment le manque de cette fonctionnalité vous a affecté ?
En donnant du contexte, vous nous aidez à réaliser une solution qui sera la plus utile possible dans le monde réel.
-->
## (Optionnel) Votre environnement 🌎
<!--
OPTIONNEL - Seulement pour les issues techniques (par exemple : concernant les CI/CD, la documentation, le style/configuration associé au linter ...)
IMPORTANT - Vous pouvez supprimer cette section et son contenu si vous ne voulez pas la compléter.
Ajouter autant de détails que vous jugez utile sur l'environnement avec lequel vous avez eu l'issue.
S'il vous plait, complétez la table qui suit si cette issue relève du domaine technique.
-->
| Env infos | Version |
| ----------- | ------- |
| Nom du navigateur | |
| Sur un smartphone | :no_entry_sign: or :heavy_check_mark: |
## Actions rapides
<!---Ne touchez pas à cette section sauf si vous savez ce que vous faites. Ces actions rapides sont là pour améliorer le traitement des issues par la suite.--->
/label "Awaiting Feedback"
# Basic issue
<!--
Thank you for contributing to this project by creating an issue!
To avoid duplicate issues we ask you to check off the following list.
Before you start writing this issue, please check that the available issue template don't correspond to your kind of issue.
If there is any template corresponding, please change the "Basic issue" title to a more explicit title and feel free to add sections.
-->
<!-- Checked checkbox should look like this: [x] -->
- [ ] The issue is present in the latest release.
- [ ] I have searched the [issues](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/issues) of this repository and believe that this is not a duplicate.
## Context 🔦
<!--
What are you trying to accomplish? How has this issue affected you?
Providing context helps us come up with a solution that is most useful in the real world.
-->
## (Optional) Your Environment 🌎
<!--
OPTIONAL - Only for technical issue (for example: concerning CI/CD, code documentation/style/linter ...).
IMPORTANT - You can erase this section and its content if you don"t want to complete it.
Include as many relevant details about the environment with which you experienced the issue.
Please complete the following table if this issue is technical.
-->
| Env infos | Version |
| ----------- | ------- |
| Browser name | |
| On Smartphone | :no_entry_sign: or :heavy_check_mark: |
## Quick actions
<!---Don't touch this section unless you know what you do. Theses quick actions are here to enhance the treatment of issues afterwards.--->
/label "Awaiting Feedback"
# Découverte de bug
<!--
Nous vous remercions de contribuer à ce projet par la création de cette issue !
Pour éviter les duplicats, nous vous demandons de cocher les cases dans la liste qui suit.
-->
<!-- Cocher une case doit ressembler à ceci : [x] -->
- [ ] Cette issue est présente dans la dernière version livrée.
- [ ] J'ai cherché dans les [issues](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/issues) de ce répertoire et crois que ceci n'est pas un duplicat.
## Comportement actuel 😯
<!-- Décrivez ce qui arrive et qui différe du comportement attendu. -->
## Comportement attendu 🤔
<!-- Décrivez ce qui devrait arriver. -->
## Etapes pour reproduire 🕹
<!--
Donnez un lien vers un exemple disponible et un ensemble d'étapes claires à suivre pour reproduire le bug.
Les issues sans exemples disponibles auront un temps de réponse/résolution plus long de la part de l'équipe.
-->
Etapes à reproduire:
1.
1.
1.
1.
## (Optionnel) Contexte 🔦
<!--
Qu'essayez vous d'accomplir ? Comment ce bug vous a affecté ?
En donnant du contexte, vous nous aidez à réaliser une solution qui sera la plus utile possible dans le monde réel.
-->
## Your Environment 🌎
<!--
Ajouter autant de détails que vous juge utile sur l'environnement avec lequel vous avez eu le bug.
S'il vous plait, complétez la table qui suit si cette issue relève du domaine technique.
-->
| Env infos | Version |
| ----------- | ------- |
| Nom du navigateur | |
| Sur un smartphone | :no_entry_sign: or :heavy_check_mark: |
## Actions rapides
<!---Ne touchez pas à cette section sauf si vous savez ce que vous faites. Ces actions rapides sont là pour améliorer le traitement des issues par la suite.--->
/label Priority::High
/label Bug::Discovery
# Bug dans une application
# Bug discovery
## Sommaire
> Rapide description du bug rencontré.
<!--
Thank you for contributing to this project by creating an issue!
To avoid duplicate issues we ask you to check off the following list.
-->
<!-- Checked checkbox should look like this: [x] -->
- [ ] The issue is present in the latest release.
- [ ] I have searched the [issues](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/issues) of this repository and believe that this is not a duplicate.
## Etapes pour reproduire le bug
> Décrivez comment obtenir le bug.
## Current Behavior 😯
<!-- Describe what happens instead of the expected behavior. -->
## Expected Behavior 🤔
## Résultat attendu
> Décrivez le résulat que vous souhaitiez obtenir lorsque vous avez rencontré le bug.
<!-- Describe what should happen. -->
## Steps to Reproduce 🕹
<!--
Provide a link to a live example and an unambiguous set of steps to reproduce this bug.
Issues without some form of live example have a longer response time.
-->
## Résulta obtenu
> Décrivez le resutat que vous avez obtenu à la place.
Steps:
1.
1.
1.
1.
## (Optional) Context 🔦
## Notes
> Ajoutez tous les éléments que vous pensez nécessaire.
<!--
What are you trying to accomplish? How has this issue affected you?
Providing context helps us come up with a solution that is most useful in the real world.
-->
## Your Environment 🌎
<!--
Include as many relevant details about the environment with which you experienced the bug.
Please complete the following table.
-->
| Env infos | Version |
| ----------- | ------- |
| Browser name | |
| On Smartphone | :no_entry_sign: or :heavy_check_mark: |
## Quick actions
<!---Ne modifiez ce paragraphe que si vous savez ce que vous faites. Ces quick actions sont là pour faire en sorte que les issues soient traitées de manière la plus efficace.--->
/label Priorité::haute
/label Bug
<!---Don't touch this section unless you know what you do. Theses quick actions are here to enhance the treatment of issues afterwards.--->
/label Priority::High
/label Bug::Discovery
# Issue concernant la documentation
<!--
Nous vous remercions de contribuer à ce projet par la création de cette issue !
Pour éviter les duplicats, nous vous demandons de cocher les cases dans la liste qui suit.
-->
<!-- Cocher une case doit ressembler à ceci : [x] -->
- [ ] Cette issue concerne la dernière version mise en ligne.
- [ ] J'ai cherché dans les [issues](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/issues) de ce répertoire et crois que ceci n'est pas un duplicat.
## Besoin 💡
<!-- Décrivrez ce qu'il vous manque dans la documentation sur ce projet, ce qu'il faudrait ajouter. -->
## Exemples 🌈
<!--
Fournisez un lien vers des ressources pour nous aider à documenter.
-->
## Motivation 🔦
<!--
Qu'essayez vous d'accomplir ? Comment le manque dans la documentation vous a affecté ?
En donnant du contexte, vous nous aidez à réaliser une solution qui sera la plus utile possible dans le monde réel.
-->
## Actions rapides
<!---Ne touchez pas à cette section sauf si vous savez ce que vous faites. Ces actions rapides sont là pour améliorer le traitement des issues par la suite.--->
/label Documentation
/label "Awaiting Feedback"
# Documentation issue
<!--
Thank you for contributing to this project by creating an issue!
To avoid duplicate issues we ask you to check off the following list.
-->
<!-- Checked checkbox should look like this: [x] -->
- [ ] The issue is present in the latest release.
- [ ] I have searched the [issues](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/issues) of this repository and believe that this is not a duplicate.
## Summary 💡
<!-- Describe how the documentation should change. -->
## Examples 🌈
<!--
Provide a link to some resources, user story, or screenshots to help us solve this issue.
-->
## Motivation 🔦
<!--
What are you trying to accomplish? How has the lack of documentation affected you?
Providing context helps us come up with a solution that is most useful in the real world.
-->
## Quick actions
<!---Don't touch this section unless you know what you do. Theses quick actions are here to enhance the treatment of issues afterwards.--->
/label Documentation
/label "Awaiting Feedback"
# Demande de fonctionnalités
<!--
Nous vous remercions de contribuer à ce projet par la création de cette issue !
Pour éviter les duplicats, nous vous demandons de cocher les cases dans la liste qui suit.
-->
<!-- Cocher une case doit ressembler à ceci : [x] -->
- [ ] Cette issue est présente dans la dernière version livrée.
- [ ] J'ai cherché dans les [issues](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/issues) de ce répertoire et crois que ceci n'est pas un duplicat.
## Résumé 💡
<!-- Décrivrez comment cela devrait fonctionner. -->
## Exemples 🌈
<!--
Fournisez un lien vers des ressources, user story, ou des captures d'écran du comportement attendu.
-->
## Motivation 🔦
<!--
Qu'essayez vous d'accomplir ? Comment le manque de cette fonctionnalité vous a affecté ?
En donnant du contexte, vous nous aidez à réaliser une solution qui sera la plus utile possible dans le monde réel.
-->
## Actions rapides
<!---Ne touchez pas à cette section sauf si vous savez ce que vous faites. Ces actions rapides sont là pour améliorer le traitement des issues par la suite.--->
/label Feature
/label "Awaiting Feedback"
# Feature request
<!--
Thank you for contributing to this project by creating an issue!
To avoid duplicate issues we ask you to check off the following list.
-->
<!-- Checked checkbox should look like this: [x] -->
- [ ] The issue is present in the latest release.
- [ ] I have searched the [issues](https://gitlab.com/sia-insa-lyon/|BdEINSALyon/serveur-affichage-dynamique/issues) of this repository and believe that this is not a duplicate.
## Summary 💡
<!-- Describe how it should work. -->
## Examples 🌈
<!--
Provide a link to some resources, user story, or screenshots of the expected behavior.
-->
## Motivation 🔦
<!--
What are you trying to accomplish? How has the lack of this feature affected you?
Providing context helps us come up with a solution that is most useful in the real world.
-->
## Quick actions
<!---Don't touch this section unless you know what you do. Theses quick actions are here to enhance the treatment of issues afterwards.--->
/label Feature
/label "Awaiting Feedback"
<!-- Merci pour votre MR, nous apprécions votre contribution ! -->
- [ ] J'ai suivi la [section sur les MR du guide de contribution](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/-/blob/master/CONTRIBUTING.md#definition-of-done).
<!-- Ajouter une description si nécessaire ou si votre modification ne suit qu'en partie ce qui est décrit dans l'issue résolue associée -->
/assign me
/label "Merge request::Needs review"
Closes #`issue_id`
<!-- Thanks for your PR, your contribution is appreciated! -->
- [ ] I have followed the [MR section of the contributing guide](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/-/blob/master/CONTRIBUTING.md#definition-of-done).
<!-- Add description if necessary or if your modification follow partially what is described in the issue solved -->
/assign me
/label "Merge request::Needs review"
Closes #`issue_id`
## Contributing
Thank you for your interest in contributing to this GitLab project! We welcome
all contributions. By participating in this project, you agree to abide by the
[code of conduct](#code-of-conduct).
## License
By contributing to SIA project, You accept and agree to the following terms and
conditions for Your present and future Contributions submitted to this project.
All Contributions are subject to the following License terms.
[License](./LICENSE)
All Documentation content that resides under the [doc/ directory](/doc) of this
repository is licensed under Creative Commons:
[CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/).
_This notice should stay as the first item in the CONTRIBUTING.md file._
## Roles in a SIA Project
A SIA Project should have at least two contributors : a user and a maintainer.
* _User_ : A person that defines the required features, provides feedback on the software, reports usability bugs, basically, someone that actually needs the software, and has good overall knowledge about it.
* _Maintainer_ : A developer (defined below) that is an authority as to what code can be accepted or not into the project. Also, when highly sensitive bugs are discovered, the maintainer accepts to be the first to know and act about it.
Projects with more members may have :
* _Developer_ : A person that is in charge of implementing features and fixing bugs.
* _Reporter_ : A person that is in charge of bringing up issues related to bugs, help testing the software while feature implementations are in progress.
All other people are considered as _Guests_.
## Definition of done
If you contribute to a SIA project please know that changes involve more than just
code. We use the following definition of done.
Your contribution is not *done* until you have made sure it meets all of these
requirements.
1. Clear description explaining the relevancy of the contribution.
1. Working and clean code that is commented where needed. If this is your first contribution, please read the [GitLab JavaScript style guide](https://docs.gitlab.com/ee/development/fe_guide/style/javascript.html).
1. Unit, integration, and system tests that all pass on the CI server.
1. Regressions and bugs are covered with tests that reduce the risk of the issue happening
again.
1. [Changelog entry added](./CHANGELOG.md), if necessary.
1. [Documented](../doc/index.md) in the `/doc` directory (if the doc is automatically generated, check that everything is fine).
1. Reviewed by relevant (UX/FE/BE/tech writing) reviewers and all concerns are addressed.
1. Confirmed to be working in the Pre-prod stage.
1. Merged by a project maintainer.
1. Added to the release post if relevant.
## I want to contribute!
If you want to contribute to this SIA Project, issues with both the ~"Accepting merge requests" and ~"For Scheduling" labels
are issues that have been triaged as areas where we are looking for contributors to help us out.
See the [contributor issues list](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/-/issues?scope=all&utf8=%E2%9C%93&state=opened&label_name[]=Accepting%20merge%20requests&label_name[]=For%20Scheduling).
If you have any questions or need help, contact a member of SIA INSA Lyon.
## Maintainer documentation
Maintainers of this project will try to address issues in a timely manner.
Maintainers, however, cannot guarantee that they would be able to address
all incoming issues as soon as they are raised nor can guarantee to provide an
answer to all raised issues.
If your issue is closed due to inactivity (from either side), please check
whether the issue persists in the latest version. If that is the case, feel free
to reopen the issue or create a new one with a link to the old issue.
### Issue description templates
Issue description template will show this message to
all users that create issues in this repository:
```
When submitting an issue, please check the following:
- [ ] The issue is present in the latest release.
- [ ] I have searched the [issues](https://gitlab.com/sia-insa-lyon/BdEINSALyon/serveur-affichage-dynamique/issues) of this repository and believe that this is not a duplicate.
```
English is mandatory only for issues meant for new contributors, French can be used otherwise to simplify the understanding beetween SIA members.
### Issue response template
When the maintainer suspects the reported issue is not related to the problems with this project, following template can be used to respond to the issue reporter:
```
Thanks for reporting this issue. I suspect that the issue you are experiencing is not related to the project or configuration of the project itself.
Since this looks like a problem not related to the project please contact a SIA member for your issue. I will close this issue but if you still think this is a problem with the project please @ mention me with the steps to reproduce the problem and I will reopen the issue.
```
### Closing issues
If an issue has a ~"Awaiting Feedback" label, and the response from the reporter
has not been received for 1 month, we can close the issue using the following
response template:
```
We haven't received an update for more than 14 days so we will assume that the
problem is fixed or is no longer valid. If you still experience the same problem
try upgrading to the latest version. If the issue persists, reopen this issue
with the relevant information.
```
### Reviewing Merge Requests (MR)
Before merging, a MR must be reviewed by a project Maintainer.
If the change is not time-sensitive, then the MR can first be reviewed by any other Dev Team Member then finally reviewed by a Maintainer.
Reviews generally only need the *approval* of one Maintainer to be merged, but
additional Maintainers may be involved with reviewing parts of the change. We will
try to avoid having more than one Maintainer do a full review.
**When the MR affects/answers to an issue that has not been properly defined**
The project users must review the issue formulation, and the maintainer should only review the code itself.
**Other changes**
As long as one of the Maintainers is confident in the change, it does not need to
be reviewed again before merge.
> **Note**: This process is intended to balance code quality with effective use of reviewers' time. Just because a change was approved and merged by one Maintainer, does not guarantee that it won't be reverted later.
## Code of conduct
As contributors and maintainers of this project, we pledge to respect all people
who contribute through reporting issues, posting feature requests, updating
documentation, submitting pull requests or patches, and other activities.
We are committed to making participation in this project a harassment-free
experience for everyone, regardless of level of experience, gender, gender
identity and expression, sexual orientation, disability, personal appearance,
body size, race, ethnicity, age, or religion.
Examples of unacceptable behavior by participants include the use of sexual
language or imagery, derogatory comments or personal attacks, trolling, public
or private harassment, insults, or other unprofessional conduct.
Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct. Contributors involved with the project that do not follow the
Code of Conduct may be removed from the project team.
This code of conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community.
Instances of abusive, harassing, or otherwise unacceptable behavior can be
reported by emailing contact@gitlab.com.
This Code of Conduct is adapted from the [Contributor Covenant][contributor-covenant], version 1.1.0,
available at [http://contributor-covenant.org/version/1/1/0/](http://contributor-covenant.org/version/1/1/0/).
[contributor-covenant]: http://contributor-covenant.org
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment