From ceade396a327145fe055d13fcec3c85547c02a75 Mon Sep 17 00:00:00 2001 From: cmoineau <cyril.moineau@cea.fr> Date: Tue, 27 Feb 2024 09:22:30 +0000 Subject: [PATCH] Add default MR template, add Documentation and Feature issue template. --- .gitlab/issue_templates/Documentation.md | 12 +++++++++ .gitlab/issue_templates/Feature.md | 14 ++++++++++ .gitlab/merge_request_templates/Default.md | 31 ++++++++++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 .gitlab/issue_templates/Documentation.md create mode 100644 .gitlab/issue_templates/Feature.md create mode 100644 .gitlab/merge_request_templates/Default.md diff --git a/.gitlab/issue_templates/Documentation.md b/.gitlab/issue_templates/Documentation.md new file mode 100644 index 0000000..ab502d8 --- /dev/null +++ b/.gitlab/issue_templates/Documentation.md @@ -0,0 +1,12 @@ +## Faulty documentation + +(Present here what you think is missing/not up to date in the documentation) + +[link to the faulty documentation if possible]($PATH_TO_DOC) + +## Possible Fixes + +(If you can, suggest a possible fix) + + +/label ~Add::Documentation 📚 diff --git a/.gitlab/issue_templates/Feature.md b/.gitlab/issue_templates/Feature.md new file mode 100644 index 0000000..96b77d3 --- /dev/null +++ b/.gitlab/issue_templates/Feature.md @@ -0,0 +1,14 @@ +## Description + +(Explain the problem to be solved) + +## Proposal + +(Describe the solution you'd like - A clear and concise description of what you want to happen) + +## Additional context + +(If you want, add any other context or screenshots about the feature request) + + +/label ~Add::Feature diff --git a/.gitlab/merge_request_templates/Default.md b/.gitlab/merge_request_templates/Default.md new file mode 100644 index 0000000..a0b8f8a --- /dev/null +++ b/.gitlab/merge_request_templates/Default.md @@ -0,0 +1,31 @@ +## Context + +(Summarize the problem you are facing and the solution you propose to resolve the issue) + +(If possible add link to a gitlab issue #...) + +(Describe the issue - you can paste any logs or/screenshots, the link to the line of code that might be responsible for the problem) + +(In the case of feature addition, describe the context arround the need of this addition) + +## Modified files + +(Summarize the changes you made for each modified file - example: +- `DeepNet.hpp` and `DeepNet.cpp`, add several learning methods; +- `learn.cpp`, to include the learning functions inside the main function; +- `test_conv.cpp`, to correct the new syntax in the tests; ) + +## Detailed major modifications + +(Explain the non-trivial changes you made in the modified files) + +(Specify if you made an important technical decision which should be added to the wiki https://gitlab.eclipse.org/groups/eclipse/aidge/-/wikis/home or the documentation) + + +## TODO + +(List the changes that need to be done to track the progress of the MR, you need to update the list when committing !) + +- [ ] NOT DONE +- [X] DONE +- [ ] TO DO -- GitLab