From bdfc9717f804638b6bb629a6a5563e53157ebeaf Mon Sep 17 00:00:00 2001 From: jvelazquezm Date: Wed, 14 May 2025 18:19:37 +0200 Subject: [PATCH] Upload issue templates --- .gitlab/issue_templates/bug.md | 38 ++++++++++++++ .gitlab/issue_templates/enhancement.md | 19 +++++++ .../new-feature-with-design.md | 52 +++++++++++++++++++ .gitlab/issue_templates/new-feature.md | 19 +++++++ 4 files changed, 128 insertions(+) create mode 100644 .gitlab/issue_templates/bug.md create mode 100644 .gitlab/issue_templates/enhancement.md create mode 100644 .gitlab/issue_templates/new-feature-with-design.md create mode 100644 .gitlab/issue_templates/new-feature.md diff --git a/.gitlab/issue_templates/bug.md b/.gitlab/issue_templates/bug.md new file mode 100644 index 0000000..9fe80fe --- /dev/null +++ b/.gitlab/issue_templates/bug.md @@ -0,0 +1,38 @@ +# Reporters +- name-of-proposer-1 (institution-of-proposer-1) +- name-of-proposer-2 (institution-of-proposer-2) +... + +# Description +Describe the bug. +If needed, Attach logs and reports to your bug. +If needed, feel free to point external content as references (journal paper, Youtube video, etc.). + +## Deployment environment +- Operating System (include version): +- MicroK8s (include version and add-ons): +- TeraFlowSDN (include release/branch-name/commit-id): + +## TFS deployment settings +- list of components deployed +- particular configurations you applied +- any other particularity you might find important + +## Sequence of actions that resulted in the bug +- be explicit and enumerate each step. +- if possible, include example calls, request files, descriptor files, etc. + +## Document the explicit error +- include the traceback of the error +- include the log files of the components / scheenshoots of WebUI (attached files) +- if known, include the list of TFS components affected by the bug + +## Expected behaviour +- describe the expected behavior (if you know it) + +## Acknowledgements +This work is funded by through the project with . + +# References +1. [Reference name](https://reference-url) +2. Author1, Author2, Author3, et. al., “My demo using feature,” in Conference-Name Demo Track, 20XX. diff --git a/.gitlab/issue_templates/enhancement.md b/.gitlab/issue_templates/enhancement.md new file mode 100644 index 0000000..f84f605 --- /dev/null +++ b/.gitlab/issue_templates/enhancement.md @@ -0,0 +1,19 @@ +# Proposers +- name-of-proposer-1 (institution-of-proposer-1) +- name-of-proposer-2 (institution-of-proposer-2) +... + +# Description +Describe your proposal in ~1000 characters. +You can reference external content listed in section "References" as [Ref-1]. + +# Demo or definition of done +Describe which high level conditions needs to be fulfilled to demonstrate this feature implementation is completed. +You can reference external content (example, demo paper) listed in section "References" as [Ref-2]. + +## Acknowledgements +This work is funded by through the project with . + +# References +1. [Reference name](https://reference-url) +2. Author1, Author2, Author3, et. al., “My demo using feature,” in Conference-Name Demo Track, 20XX. diff --git a/.gitlab/issue_templates/new-feature-with-design.md b/.gitlab/issue_templates/new-feature-with-design.md new file mode 100644 index 0000000..2af263c --- /dev/null +++ b/.gitlab/issue_templates/new-feature-with-design.md @@ -0,0 +1,52 @@ +# Proposers +- name-of-proposer-1 (institution-of-proposer-1) +- name-of-proposer-2 (institution-of-proposer-2) +... + +# Description +Describe your proposal in ~1000 characters. +You can reference external content listed in section "References" as [Ref-1]. + +# Demo or definition of done +Describe which high level conditions needs to be fulfilled to demonstrate this feature implementation is completed. +You can reference external content (example, demo paper) listed in section "References" as [Ref-2]. + +## Acknowledgements +This work is funded by through the project with . + +# References +1. [Reference name](https://reference-url) +2. Author1, Author2, Author3, et. al., “My demo using feature,” in Conference-Name Demo Track, 20XX. + +# Feature Design (for New-Features) + +## Clarifications to Expected Behavior Changes +Existing component logic and workflows between components that need to be altered to realize this feature. +Remember to justify these changes. +... + +## References +List of relevant references for this feature. +... + +## Assumptions +Enumerate the assumptions for this feature, e.g., fix XXX is implemented and merged, specific configurations, specific +components deployed. +... + +## Impacted Components +List of impacted components: Context, Device, Service, PathComp, Slice, Monitoring, ZTP, Policy, NBI, etc. +Just an enumeration, elaboration of impacts is done below. + +## Component1 Impact +Describe impact (changes) on component1. +... + +## Component2 Impact +Describe impact (changes) on component2. +... + +## Testing +Describe test sets (unitary and integration) to be carried out. +This section can include/reference external experiments, demo papers, etc. +... diff --git a/.gitlab/issue_templates/new-feature.md b/.gitlab/issue_templates/new-feature.md new file mode 100644 index 0000000..f84f605 --- /dev/null +++ b/.gitlab/issue_templates/new-feature.md @@ -0,0 +1,19 @@ +# Proposers +- name-of-proposer-1 (institution-of-proposer-1) +- name-of-proposer-2 (institution-of-proposer-2) +... + +# Description +Describe your proposal in ~1000 characters. +You can reference external content listed in section "References" as [Ref-1]. + +# Demo or definition of done +Describe which high level conditions needs to be fulfilled to demonstrate this feature implementation is completed. +You can reference external content (example, demo paper) listed in section "References" as [Ref-2]. + +## Acknowledgements +This work is funded by through the project with . + +# References +1. [Reference name](https://reference-url) +2. Author1, Author2, Author3, et. al., “My demo using feature,” in Conference-Name Demo Track, 20XX. -- GitLab