]> xenbits.xensource.com Git - unikraft/unikraft.git/commitdiff
.github: Introduce 'project backlog' issue template
authorAlexander Jung <a.jung@lancs.ac.uk>
Wed, 14 Jul 2021 16:56:50 +0000 (18:56 +0200)
committerUnikraft <monkey@unikraft.io>
Tue, 27 Jul 2021 05:27:40 +0000 (05:27 +0000)
This commit introduces a Github-centric configuration file which
provides a template during the creation of a new issue.  This file
is used to help with defining a feature request or "project
backlog" issue submitted to the Unikraft core repository.  More
information about issue templates can be found at [0].

[0]: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates#issue-templates

Signed-off-by: Alexander Jung <a.jung@lancs.ac.uk>
Reviewed-by: Razvan Deaconescu <razvan.deaconescu@cs.pub.ro>
Tested-by: Unikraft CI <monkey@unikraft.io>
GitHub-Pull-Request: #256

.github/ISSUE_TEMPLATE/project_backlog.yml [new file with mode: 0644]

diff --git a/.github/ISSUE_TEMPLATE/project_backlog.yml b/.github/ISSUE_TEMPLATE/project_backlog.yml
new file mode 100644 (file)
index 0000000..ae79f1c
--- /dev/null
@@ -0,0 +1,51 @@
+name: ðŸ“¥ Add to the backlog
+description: Create an issue for new work to be done which has been discussed.
+labels: [kind/enhancement]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please only use this form to submit new, well-defined work to the Unikraft project's backlog.  Issues under this category have been discussed with the core team.
+
+        If you're intending to request a feature, please [open a discussion using the "Ideas" category](https://github.com/unikraft/unikraft/discussions/new) instead so we can understand your workflow first.  If you are unsure about a feature, please [check out our documentation](https://docs.unikraft.org/) which covers existing features and possibilities with Unikraft or filter existing issues labelled under [`kind/enhancement`](https://github.com/unikraft/unikraft/labels/kind/enhancement) to prevent double-posting.
+  - type: textarea
+    id: feature-request-summary
+    attributes:
+      label: Feature request summary
+      description: Please provide a quick summary which clearly and concisely describes the feature.  For example, highlights of new functionality; proposal of a new architecture or platform; additions to documentation; etc.
+    validations:
+      required: true
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Describe alternatives
+      description: A clear and concise description of any alternative solutions or features considered.
+    validations:
+      required: false
+  - type: dropdown
+    id: related-architectures
+    attributes:
+      label: Related architectures
+      description: Please indicate whether the feature request is related to a specific architecture.  If this feature is architecture agnostic or you are unsure then please do not select an architecture listed below.
+      multiple: false
+      options:
+        - x86_64
+        - arm
+        - arm64
+  - type: dropdown
+    id: related-platforms
+    attributes:
+      label: Related platforms
+      description: Please indicate whether the feature request is related to a specific platform.  If this feature is platform agnostic or you are unsure then please do not select an platform listed below.
+      multiple: false
+      options:
+        - kvm
+        - xen
+        - linuxu
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: Additional context
+      description: Add any other context, longer descriptions, screenshot/mock-ups, or links to related material about the feature request.
+    validations:
+      required: false