Skip to content

Commit 0981320

Browse files
abhi1693abhi1693
authored
Merge pull request #572 from netbox-community/chore/317
Adds issue and PR templates
2 parents a0da422 + df137fa commit 0981320

File tree

7 files changed

+238
-0
lines changed

7 files changed

+238
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.yaml

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
name: 🐛 Bug Report
3+
description: Report a reproducible bug in the current release of pynetbox
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 pynetbox release.
10+
- type: input
11+
attributes:
12+
label: pynetbox version
13+
description: What version of pynetbox are you currently running?
14+
placeholder: v7.1.0
15+
validations:
16+
required: true
17+
- type: input
18+
attributes:
19+
label: NetBox version
20+
description: What version of NetBox are you currently running?
21+
placeholder: v3.5.8
22+
validations:
23+
required: true
24+
- type: dropdown
25+
attributes:
26+
label: Python version
27+
description: What version of Python are you currently running?
28+
options:
29+
- "3.8"
30+
- "3.9"
31+
- "3.10"
32+
- "3.11"
33+
validations:
34+
required: true
35+
- type: textarea
36+
attributes:
37+
label: Steps to Reproduce
38+
description: >
39+
Please provide a minimal working example to demonstrate the bug. Begin with the
40+
initialization of any necessary database objects and clearly enumerate each
41+
operation carried out. Ensure that your example is as concise as possible
42+
while adequately illustrating the issue. For example:
43+
```python
44+
>>> import pynetbox
45+
>>> nb = pynebox.api('https://netbox.example.com', token='my-token')
46+
47+
```
48+
Note: **do not utilize the demo instance** for replicating suspected bugs,
49+
as its data is subject to change or removal at any time.
50+
51+
_Please refrain from including any confidential or sensitive
52+
information in your example._
53+
validations:
54+
required: true
55+
- type: textarea
56+
attributes:
57+
label: Expected Behavior
58+
description: What did you expect to happen?
59+
placeholder: The script should execute without raising any errors or exceptions
60+
validations:
61+
required: true
62+
- type: textarea
63+
attributes:
64+
label: Observed Behavior
65+
description: What happened instead?
66+
placeholder: A TypeError exception was raised
67+
validations:
68+
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/netbox/blob/develop/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/pynetbox/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/deprecation.yaml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: 🗑️ Deprecation
3+
description: The removal of an existing feature or resource
4+
labels: ["type: deprecation"]
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Proposed Changes
9+
description: >
10+
Describe in detail the proposed changes. What is being removed?
11+
validations:
12+
required: true
13+
- type: textarea
14+
attributes:
15+
label: Justification
16+
description: Please provide justification for the proposed change(s).
17+
validations:
18+
required: true
19+
- type: textarea
20+
attributes:
21+
label: Impact
22+
description: List all areas of the application that will be affected by this change.
23+
validations:
24+
required: true

‎.github/ISSUE_TEMPLATE/documentation_change.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: 📖 Documentation Change
3+
description: Suggest an addition or modification to the pynetbox documentation
4+
labels: ["type: documentation"]
5+
body:
6+
- type: dropdown
7+
attributes:
8+
label: Change Type
9+
description: What type of change are you proposing?
10+
options:
11+
- Addition
12+
- Correction
13+
- Removal
14+
- Cleanup (formatting, typos, etc.)
15+
validations:
16+
required: true
17+
- type: dropdown
18+
attributes:
19+
label: Area
20+
description: To what section of the documentation does this change primarily pertain?
21+
options:
22+
- Endpoint
23+
- Response
24+
- Request
25+
- IPAM
26+
- Other
27+
validations:
28+
required: true
29+
- type: textarea
30+
attributes:
31+
label: Proposed Changes
32+
description: Describe the proposed changes and why they are necessary.
33+
validations:
34+
required: true

‎.github/ISSUE_TEMPLATE/feature_request.yaml

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
---
2+
name: ✨ Feature Request
3+
description: Propose a new pynetbox 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+
pynetbox 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: pynetbox version
16+
description: What version of pynetbox are you currently running?
17+
placeholder: v7.1.0
18+
validations:
19+
required: true
20+
- type: input
21+
attributes:
22+
label: NetBox version
23+
description: What version of NetBox are you currently running?
24+
placeholder: v3.5.8
25+
validations:
26+
required: true
27+
- type: dropdown
28+
attributes:
29+
label: Feature type
30+
options:
31+
- Data model extension
32+
- New functionality
33+
- Change to existing functionality
34+
validations:
35+
required: true
36+
- type: textarea
37+
attributes:
38+
label: Proposed functionality
39+
description: >
40+
Describe in detail the new feature or behavior you are proposing. Include any specific changes
41+
to work flows, data models, and/or the user interface. The more detail you provide here, the
42+
greater chance your proposal has of being discussed. Feature requests which don't include an
43+
actionable implementation plan will be rejected.
44+
validations:
45+
required: true
46+
- type: textarea
47+
attributes:
48+
label: Use case
49+
description: >
50+
Explain how adding this functionality would benefit pynetbox users. What need does it address?
51+
validations:
52+
required: true
53+
- type: textarea
54+
attributes:
55+
label: External dependencies
56+
description: >
57+
List any new dependencies on external libraries or services that this new feature would
58+
introduce. For example, does the proposal require the installation of a new Python package?
59+
(Not all new features introduce new dependencies.)

‎.github/ISSUE_TEMPLATE/housekeeping.yaml

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

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!--
2+
Thank you for your interest in contributing to pynetbox! Please note that
3+
our contribution policy requires that a feature request or bug report be
4+
approved and assigned prior to opening a pull request. This helps avoid
5+
waste time and effort on a proposed change that we might not be able to
6+
accept.
7+
8+
IF YOUR PULL REQUEST DOES NOT REFERENCE AN ISSUE WHICH HAS BEEN ASSIGNED
9+
TO YOU, IT WILL BE CLOSED AUTOMATICALLY.
10+
11+
Please specify your assigned issue number on the line below.
12+
-->
13+
### Fixes: #1234
14+
15+
<!--
16+
Please include a summary of the proposed changes below.
17+
-->

0 commit comments

Comments
 (0)