Skip to content
This repository has been archived by the owner on May 2, 2022. It is now read-only.

Issues Standards

Martin Senécal edited this page Jan 17, 2022 · 4 revisions

General Guidelines

  • Don't forget to close the issues when it is done.
  • Issues will be used for development, documentation, and bug tasks.
  • Each User Story contains multiple sub-tasks.
  • Bugs will be used for small fixes/problems, where it is not 100% related to a new feature.

Issues Templates

  1. When creating a new issue, you have 5 options:

    • Bug Report: something is not working correctly.
    • DevOps: a task related to CI/CD, Deployment, Automated Tests, etc.
    • Documentation Issue: something that we have to add in the documentation (either in code, or wiki). It will be mostly issues regarding the evaluations.
    • Story Request: Add a new feature with many sub-tasks. (follow template: As "user" I want "what" because "value")
    • Feature Request: Suggest an idea for this project. Will then be broken down into smaller user stories. This option is mostly reserved for the customers.
  2. For the title of the issue, replace TITLE for a smaller description of the tasks.

  3. Add information in the body (template is already there, so just add the missing pieces).

  4. Important! On the right side, you have to add some info:

    • Assignees: If you already know who will be working on it, you could add a name. If you don't know yet, no need to put a name yet.
    • Labels: Should already be there (because of the template)
    • Projects: Add the issue inside the right project!!
    • Milestone: If you already know, add the milestone (Sprint).
  5. [When you are done] Link the issue to your pull request.