Skip to content

Commit a3d0f81

Browse files
authored
update for version 0.2 (#16)
1 parent 4f618d4 commit a3d0f81

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1568
-464
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 0 additions & 23 deletions
This file was deleted.
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
name: 🐛 Bug Report
3+
description: Report a reproducible bug in the current release of cookiecutter-netbox-plugin
4+
labels: ["type: bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
**NOTE:** This form is only for reporting _reproducible bugs_ in a current cookiecutter-netbox-plugin release.
10+
- type: input
11+
attributes:
12+
label: cookiecutter-netbox-plugin version
13+
description: What version of cookiecutter-netbox-plugin are you currently running?
14+
placeholder: v0.1.0
15+
validations:
16+
required: true
17+
- type: dropdown
18+
attributes:
19+
label: Python version
20+
description: What version of Python are you currently running?
21+
options:
22+
- "3.8"
23+
- "3.9"
24+
- "3.10"
25+
- "3.11"
26+
validations:
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Steps to Reproduce
31+
description: >
32+
Please provide a minimal working example to demonstrate the bug. Begin with the
33+
initialization of any necessary database objects and clearly enumerate each
34+
operation carried out. Ensure that your example is as concise as possible
35+
while adequately illustrating the issue.
36+
37+
_Please refrain from including any confidential or sensitive
38+
information in your example._
39+
validations:
40+
required: true
41+
- type: textarea
42+
attributes:
43+
label: Expected Behavior
44+
description: What did you expect to happen?
45+
placeholder: The script should execute without raising any errors or exceptions
46+
validations:
47+
required: true
48+
- type: textarea
49+
attributes:
50+
label: Observed Behavior
51+
description: What happened instead?
52+
placeholder: A TypeError exception was raised
53+
validations:
54+
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Reference: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
2+
blank_issues_enabled: false
3+
contact_links:
4+
- name: 📖 Contributing Policy
5+
url: https://github.com/netbox-community/cookiecutter-netbox-plugin/blob/main/CONTRIBUTING.md
6+
about: "Please read through our contributing policy before opening an issue or pull request."
7+
- name: ❓ Discussion
8+
url: https://github.com/netbox-community/cookiecutter-netbox-plugin/discussions
9+
about: "If you're just looking for help, try starting a discussion instead."
10+
- name: 💬 Community Slack
11+
url: https://netdev.chat
12+
about: "Join #netbox on the NetDev Community Slack for assistance with installation issues and other problems."

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 0 additions & 17 deletions
This file was deleted.
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
name: ✨ Feature Request
3+
description: Propose a new cookiecutter-netbox-plugin feature or enhancement
4+
labels: ["type: feature"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
**NOTE:** This form is only for submitting well-formed proposals to extend or modify
10+
cookiecutter-netbox-plugin in some way. If you're trying to solve a problem but can't figure out how, or if
11+
you still need time to work on the details of a proposed new feature, please start a
12+
[discussion](https://github.com/netbox-community/pynetbox/discussions) instead.
13+
- type: input
14+
attributes:
15+
label: cookiecutter-netbox-plugin version
16+
description: What version of cookiecutter-netbox-plugin are you currently running?
17+
placeholder: v0.1.0
18+
validations:
19+
required: true
20+
- type: dropdown
21+
attributes:
22+
label: Feature type
23+
options:
24+
- Data model extension
25+
- New functionality
26+
- Change to existing functionality
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: Proposed functionality
32+
description: >
33+
Describe in detail the new feature or behavior you are proposing. Include any specific changes
34+
to work flows, data models, and/or the user interface. The more detail you provide here, the
35+
greater chance your proposal has of being discussed. Feature requests which don't include an
36+
actionable implementation plan will be rejected.
37+
validations:
38+
required: true
39+
- type: textarea
40+
attributes:
41+
label: Use case
42+
description: >
43+
Explain how adding this functionality would benefit cookiecutter-netbox-plugin users. What need does it address?
44+
validations:
45+
required: true
46+
- type: textarea
47+
attributes:
48+
label: External dependencies
49+
description: >
50+
List any new dependencies on external libraries or services that this new feature would
51+
introduce. For example, does the proposal require the installation of a new Python package?
52+
(Not all new features introduce new dependencies.)
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 🏡 Housekeeping
3+
description: A change pertaining to the codebase itself (developers only)
4+
labels: ["type: housekeeping"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
**NOTE:** This template is for use by maintainers only. Please do not submit
10+
an issue using this template unless you have been specifically asked to do so.
11+
- type: textarea
12+
attributes:
13+
label: Proposed Changes
14+
description: >
15+
Describe in detail the new feature or behavior you'd like to propose.
16+
Include any specific changes to work flows, data models, or the user interface.
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Justification
22+
description: Please provide justification for the proposed change(s).
23+
validations:
24+
required: true

0 commit comments

Comments
 (0)