From 4746eaf5a704101365de49626d60a77c2a995d82 Mon Sep 17 00:00:00 2001 From: Richard Date: Fri, 17 Feb 2023 21:08:59 +0000 Subject: [PATCH] Issue housekeeping (#2078) * Added GitHub issue templates and config.yaml for issue templating * Fixed capitalisation of labels. --- .github/ISSUE_TEMPLATES/bugreport.yaml | 62 ++++++++++++++++++++ .github/ISSUE_TEMPLATES/config.yaml | 9 +++ .github/ISSUE_TEMPLATES/feature_request.yaml | 48 +++++++++++++++ 3 files changed, 119 insertions(+) create mode 100644 .github/ISSUE_TEMPLATES/bugreport.yaml create mode 100644 .github/ISSUE_TEMPLATES/config.yaml create mode 100644 .github/ISSUE_TEMPLATES/feature_request.yaml diff --git a/.github/ISSUE_TEMPLATES/bugreport.yaml b/.github/ISSUE_TEMPLATES/bugreport.yaml new file mode 100644 index 000000000..8a3686a0f --- /dev/null +++ b/.github/ISSUE_TEMPLATES/bugreport.yaml @@ -0,0 +1,62 @@ +name: Bug Report +description: File a bug report or issue +title: "[Bug]: " +labels: ['Bug', 'triage'] +assignees: [] +body: + - type: markdown + attributes: + values: > + ## Please note: + This form should only be used if _you can reporoduce_ the bug the current + *current* release of netbox. For installation, configuration or other help with Open5GS please + use our [discussion forum](https://github.com/open5gs/open5gs/discussions). + + - type: input + attributes: + label: Open5GS Release, Revision, or Tag + placeholder: v2.6.0 + validations: + required: true + + - type: textarea + attributes: + label: Steps to reproduce + description: > + Please describe in detail the steps needed to reproduce this bug. These steps + should reproduce the issue on the most current release of Open5GS. Be sure to + include configuration and platform details. + + Please include logs from the relevant daemons as well as any relevant packet captures. + validations: + required: true + + - type: textarea + attributes: + label: Logs + description: Provide any relevant captured logs for the issue + render: shell + + - type: textarea + attributes: + label: Expected behaviour + description: What did you expect to happen? + validations: + required: true + + - type: textarea + attributes: + label: Observed Behaviour + description: What's the observed behaviour? + validations: + required: true + + - type: input + attributes: + label: eNodeB/gNodeB + description: If using an eNB or gNB, please identify which vendor/version + + - type: input + attributes: + label: UE Models and versions + description: Which UE hardware model and version or simulator version are you using? diff --git a/.github/ISSUE_TEMPLATES/config.yaml b/.github/ISSUE_TEMPLATES/config.yaml new file mode 100644 index 000000000..ba9053a81 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/config.yaml @@ -0,0 +1,9 @@ +blank_issues_enabled: false +contact_links: + - name: Open5GS Contribution Guide + url: https://github.com/open5gs/open5gs/wiki/Contribution-guide + about: Contribution guide detailing how you can help the project + - name: Project Sponsorship + url: https://github.com/sponsors/acetcom + name: Support the Open5GS developer using GitHub sponsorship + diff --git a/.github/ISSUE_TEMPLATES/feature_request.yaml b/.github/ISSUE_TEMPLATES/feature_request.yaml new file mode 100644 index 000000000..6c739b053 --- /dev/null +++ b/.github/ISSUE_TEMPLATES/feature_request.yaml @@ -0,0 +1,48 @@ +name: Feature request +description: Propose an enhancement to Open5GS +labels: ['Enhancement', 'triage'] +body: + - type: markdown + attributes: + value: > + ## Feature request + Please submit your feature request using the form. If your proposal is not sufficiently + well formed, we may request further clarification and expansion. If you're unsure about + how to formulate your request, please start a [discussion instead](https://github.com/open5gs/open5gs/dicsussions/). + + - type: input + attributes: + label: Open5GS Release, Revision, or Tag + placeholder: v2.6.0 + validations: + required: true + + - type: input + attributes: + label: Components and subsystems + description: Which subsystems and components would this feature be relevant to? + validations: + required: true + + - type: textarea + attributes: + label: Proposed functionality + description: > + Provide a detailed description of the feature or behaviour you are proposing. Please include any + Please include any relevant 3GPP standards and references and include any specific changes to + current protocols, processing pipelines, DIAMETER requests/responses, and interfaces. The more detail + you provide, the greater the chance your proposal has of being discussed. + + If your feature request does not include anything actionable or sufficient details, you may be asked + to provide further clarification or your request may be rejected. + validations: + required: true + + - type: textarea + attributes: + label: External dependencies + description: > + Please detail any new dependencies or implementations that this feature might introduce. e.g. Does the + proposal require the installation of additional packages? Are there further external nodes which may be + required for integration testing? (Not all feature requests will introduce new dependencies) +