Skip to content

Commit

Permalink
Added bug report and feature request templates (#178)
Browse files Browse the repository at this point in the history
  • Loading branch information
nwithan8 authored Apr 12, 2022
1 parent 7cb4bfa commit 4216c01
Show file tree
Hide file tree
Showing 2 changed files with 118 additions and 0 deletions.
81 changes: 81 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
name: Bug Report
description: File a bug report
title: "[Bug]: "
labels: [ "triage" ]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report an issue in this repository. Please fill out the form below.
- type: input
id: software-version
attributes:
label: Software Version
# change this description for the specific repo
description: |
What version of our software are you running?
TIP: [Available versions](https://github.com/EasyPost/easypost-python/releases)
validations:
required: true
- type: input
id: language-version
attributes:
label: Language Version
# change this description for the specific language of the repo
description: |
What language version and/or framework are you using?
TIP: [How to find your Python version](https://stackoverflow.com/questions/1093322/how-do-i-check-what-version-of-python-is-running-my-script)
validations:
required: true
- type: input
id: os
attributes:
label: Operating System
description: What operating system are you running the software on?
validations:
required: true
- type: textarea
id: behavior
attributes:
label: What happened?
description: |
Please describe what happened in reproducible steps.
Include how often you see this issue, and any relevant links (i.e. GitHub issue, Stack Overflow, etc.).
value: |
1.
2.
3.
...
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: What was expected?
description: Please describe what was expected to happen instead.
validations:
required: true
- type: textarea
id: sample-code
attributes:
label: Sample Code
description: |
Please provide any sample code that demonstrates the behavior.
This will be automatically formatted into the appropriate language, so no need for backticks.
**Do not include any private information such as API keys or passwords.**
# change this render to the appropriate language: https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
render: python3
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant logs
description: |
Please copy and paste any relevant log output.
This will be automatically formatted into shell output, so no need for backticks.
If you have screenshots instead, please paste them below.
**Do not include any private information such as API keys or passwords.**
render: sh
validations:
required: false
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: Feature Request
description: Request a new feature
title: "[Feat]: "
labels: [ "triage" ]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to request a new feature.
Please note, all feature requests are subject to review and approval.
We welcome all suggestions and ideas, but we cannot guarantee when or if we will implement them.
We also welcome pull requests, if you would like to implement the feature yourself.
Doing so will likely accelerate the process of implementing the requested feature.
- type: checkboxes
id: searched
attributes:
label: Feature Request Is New
# change issue link below for the specific repo
description: |
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).
options:
- label: I have verified that the requested feature does not already exist or has not already been requested.
required: true
- type: textarea
id: description
attributes:
label: Description of the feature
description: |
Please provide a detailed description of the feature, including:
- What the feature is
- What value it adds to the application
- How it should be implemented (i.e. pseudo-code, or a high-level description of the user experience)
- Any other relevant information
validations:
required: true

0 comments on commit 4216c01

Please sign in to comment.