PR, bug and feature templates added (#226)

* templates added

* Update bugreport.yaml

openverso-->5g

* Update feature_request.yaml

openverso-->5g
This commit is contained in:
Juan Pontón Rodríguez
2024-02-09 11:22:03 +01:00
committed by GitHub
parent 4972d7ba12
commit 38968cd175
3 changed files with 109 additions and 0 deletions

40
.github/ISSUE_TEMPLATE/bugreport.yaml vendored Normal file
View File

@@ -0,0 +1,40 @@
name: Bug Report
description: File a bug report or issue
title: "[Bug]: "
body:
- type: markdown
attributes:
value: >
**Please note**
This form should only be used if _you can reporoduce_ the bug the in the latest version of 5g-images.
**This form is not for support requests.*
- 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 5g-images. 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

View File

@@ -0,0 +1,40 @@
name: Feature request
description: Propose an enhancement to 5g-images
labels: ['Enhancement']
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.
- 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. 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)

29
.github/pull_request_template.md vendored Normal file
View File

@@ -0,0 +1,29 @@
#### What type of PR is this?
<!--
bug
cleanup
documentation
feature
-->
#### What this PR does / why we need it:
#### Which issue(s) this PR fixes:
#### Special notes for your reviewer:
#### Does this PR introduce a user-facing change?
#### Does this PR introduce new external dependencies?
#### Additional documentation:
```docs
```