From c621bcdddb6bdef0a2885e71f508bead2039459e Mon Sep 17 00:00:00 2001 From: Gerardo Marx Date: Thu, 23 Sep 2021 12:11:09 -0500 Subject: [PATCH] issues with description --- Readme.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/Readme.md b/Readme.md index 016ac37..0a73901 100644 --- a/Readme.md +++ b/Readme.md @@ -19,3 +19,19 @@ To organize your progress, use the issues and projects tabs. In this way, it is ### Issues +The `git-template` includes 9 basic labels to use each time you create an issue. These labels are detailed next: + +- bug: Somethign is not working as expected or getting wrong results +- duplicated: This issue or pull request already exists +- further work: General advices to be considered in future elements, projects or submodules +- help wanted: Some help is required by supervisors; directions, raw material, material, review results, or laboratory assistance +- improve: Something has to be improved or rebuiled to improve expected results +- question: Something needs a fast review or guidance to focus the aim of the project +- submodules: The project should considers to create a submodule element to integrate in this project +- task: Assigned task to complete a milestone or project element; the assigned collaborators have to complete the task +- wiki: Elements or information to be included in the Wiki page + +### Projects +**Considers that this is the main repository. Thus, create projects for main elements (circuit stage, specific behaivior, component, document, simulation, or submodule, etc.) to manage components or submodules related with the main repository**. + +In the project always create three main boards: Todo, In Progress and Done.