Skip to content

Commit

Permalink
Add templates and contributing guidelines (#358)
Browse files Browse the repository at this point in the history
  • Loading branch information
LeoColomb authored Oct 3, 2024
1 parent 97fc9a6 commit c2ded2a
Show file tree
Hide file tree
Showing 5 changed files with 130 additions and 1 deletion.
5 changes: 5 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# https://docs.github.com/articles/displaying-a-sponsor-button-in-your-repository

github:
- RangerRick
- LeoColomb
83 changes: 83 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: 🐛 Bug Report
description: Create a report about a malfunction of the Helm chart setup
labels:
- bug
body:
- type: markdown
attributes:
value: |
> [!NOTE]
> This form is only for reporting _reproducible bugs_ in a current NetBox
> installation **using its Helm chart**.
> If you're looking for assistance with using NetBox, please visit our
> [discussion forum](https:/netbox-community/netbox/discussions) instead.
> [!TIP]
> Please don't open an issue to open a PR. Just submit the PR, that's good enough.
- type: input
id: chart-version
attributes:
label: The Helm chart version
description: What version of the Helm chart are you running?
placeholder: netbox-5.0.0
validations:
required: true
- type: textarea
id: context-version
attributes:
label: Environment Versions
description: What version of relevant tools are you using?
render: text
placeholder: |
Kubernetes: 1.31
Helm: 3.12
FluxCD: 1.0
validations:
required: true
- type: textarea
id: chart-values-yml
attributes:
label: Custom chart values
description: Please provide your custom values (`values.yaml`)
render: yaml
placeholder: |
remoteAuth:
enabled: true
backends:
- netbox.authentication.RemoteUserBackend
ingress:
enabled: true
validations:
required: true
- type: textarea
id: current-behavior
attributes:
label: Current Behavior & Steps to Reproduce
description: Please describe what you did and how you think it misbehaved
placeholder: I tried to … by doing …, but it …
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: What did you expect to happen?
placeholder: I expected that … when I do …
validations:
required: true
- type: textarea
id: netbox-logs
attributes:
label: NetBox Logs
description: Please paste the output of the deploy Pod logs
render: text
placeholder: |
netbox_1 | ⚙️ Applying database migrations
netbox_1 | 🧬 loaded config '/etc/netbox/config/configuration.py'
netbox_1 | 🧬 loaded config '/etc/netbox/config/a.py'
netbox_1 | 🧬 loaded config '/etc/netbox/config/extra.py'
netbox_1 | 🧬 loaded config '/etc/netbox/config/logging.py'
netbox_1 | 🧬 loaded config '/etc/netbox/config/plugins.py'
...
validations:
required: false
9 changes: 9 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: false
contact_links:
- name: ❓ Question
url: https:/netbox-community/netbox/discussions
about: The Github Discussions are the right place to ask questions about how to use or do certain things with NetBox.
- name: 💬 Community Slack
url: https://netdev.chat
about: "Join #netbox-chart on the NetDev Community Slack for assistance with installation issues and other problems."
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: ✨ Feature Request
description: Propose a new NetBox feature or enhancement
labels:
- enhancement
body:
- type: markdown
attributes:
value: |
> [!NOTE]
> This form is only for submitting well-formed proposals to extend or modify
> NetBox **Helm charts** in some way.
> If you're trying to solve a problem but can't figure out how, or if
> you still need time to work on the details of a proposed new feature, please start a
> [discussion](https:/netbox-community/netbox/discussions) instead.
- type: textarea
attributes:
label: Proposed functionality
description: |
Describe in detail the new feature or behavior you are proposing. Include any specific changes
to work flows, data models, and/or the user interface. The more detail you provide here, the
greater chance your proposal has of being discussed. Feature requests which don't include an
actionable implementation plan will be rejected.
validations:
required: true
- type: textarea
attributes:
label: Use case
description: |
Explain how adding this functionality would benefit NetBox users when using its Helm chart.
What need does it address?
validations:
required: true
2 changes: 1 addition & 1 deletion charts/netbox/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: netbox
version: 5.0.0-beta.118
version: 5.0.0-beta.119
appVersion: "v4.1.3"
type: application
kubeVersion: ^1.25.0-0
Expand Down

0 comments on commit c2ded2a

Please sign in to comment.