Skip to content

Commit 4216c01

Browse files
authored
Added bug report and feature request templates (#178)
1 parent 7cb4bfa commit 4216c01

File tree

2 files changed

+118
-0
lines changed

2 files changed

+118
-0
lines changed
Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "[Bug]: "
4+
labels: [ "triage" ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to report an issue in this repository. Please fill out the form below.
10+
- type: input
11+
id: software-version
12+
attributes:
13+
label: Software Version
14+
# change this description for the specific repo
15+
description: |
16+
What version of our software are you running?
17+
TIP: [Available versions](https://github.com/EasyPost/easypost-python/releases)
18+
validations:
19+
required: true
20+
- type: input
21+
id: language-version
22+
attributes:
23+
label: Language Version
24+
# change this description for the specific language of the repo
25+
description: |
26+
What language version and/or framework are you using?
27+
TIP: [How to find your Python version](https://stackoverflow.com/questions/1093322/how-do-i-check-what-version-of-python-is-running-my-script)
28+
validations:
29+
required: true
30+
- type: input
31+
id: os
32+
attributes:
33+
label: Operating System
34+
description: What operating system are you running the software on?
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: behavior
39+
attributes:
40+
label: What happened?
41+
description: |
42+
Please describe what happened in reproducible steps.
43+
Include how often you see this issue, and any relevant links (i.e. GitHub issue, Stack Overflow, etc.).
44+
value: |
45+
1.
46+
2.
47+
3.
48+
...
49+
validations:
50+
required: true
51+
- type: textarea
52+
id: expected-behavior
53+
attributes:
54+
label: What was expected?
55+
description: Please describe what was expected to happen instead.
56+
validations:
57+
required: true
58+
- type: textarea
59+
id: sample-code
60+
attributes:
61+
label: Sample Code
62+
description: |
63+
Please provide any sample code that demonstrates the behavior.
64+
This will be automatically formatted into the appropriate language, so no need for backticks.
65+
**Do not include any private information such as API keys or passwords.**
66+
# change this render to the appropriate language: https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
67+
render: python3
68+
validations:
69+
required: false
70+
- type: textarea
71+
id: logs
72+
attributes:
73+
label: Relevant logs
74+
description: |
75+
Please copy and paste any relevant log output.
76+
This will be automatically formatted into shell output, so no need for backticks.
77+
If you have screenshots instead, please paste them below.
78+
**Do not include any private information such as API keys or passwords.**
79+
render: sh
80+
validations:
81+
required: false
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: Feature Request
2+
description: Request a new feature
3+
title: "[Feat]: "
4+
labels: [ "triage" ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for taking the time to request a new feature.
10+
Please note, all feature requests are subject to review and approval.
11+
We welcome all suggestions and ideas, but we cannot guarantee when or if we will implement them.
12+
13+
We also welcome pull requests, if you would like to implement the feature yourself.
14+
Doing so will likely accelerate the process of implementing the requested feature.
15+
- type: checkboxes
16+
id: searched
17+
attributes:
18+
label: Feature Request Is New
19+
# change issue link below for the specific repo
20+
description: |
21+
Before we begin, please confirm that the requested feature does not already exist or has not [already been requested](https://github.com/EasyPost/easypost-python/issues).
22+
options:
23+
- label: I have verified that the requested feature does not already exist or has not already been requested.
24+
required: true
25+
- type: textarea
26+
id: description
27+
attributes:
28+
label: Description of the feature
29+
description: |
30+
Please provide a detailed description of the feature, including:
31+
- What the feature is
32+
- What value it adds to the application
33+
- How it should be implemented (i.e. pseudo-code, or a high-level description of the user experience)
34+
- Any other relevant information
35+
validations:
36+
required: true
37+

0 commit comments

Comments
 (0)