Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PR. bug and feature request templates added #147

Merged
merged 2 commits into from
Jan 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bugreport.yaml
Original file line number Diff line number Diff line change
@@ -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 openverso-charts.

**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 openverso-charts. 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

38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Feature request
description: Propose an enhancement to openverso-charts
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)
36 changes: 36 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!--
PR REQUIREMENTS

The chart version must be bumped in chart.yaml. Then the chart must be linted by running scripts/lint.sh
-->


#### 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

```