Skip to content

Commit

Permalink
chore: add github issue and feature request templates (#306)
Browse files Browse the repository at this point in the history
Signed-off-by: Keming <[email protected]>
  • Loading branch information
kemingy committed Apr 24, 2023
1 parent 69fe8e0 commit 65d8c1f
Show file tree
Hide file tree
Showing 6 changed files with 79 additions and 34 deletions.
33 changes: 0 additions & 33 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Bug Report
description: Bug report for spectree
labels: ["bug"]
title: "bug: <title>"
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: To Reproduce
description: Steps to reproduce the behavior.
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: false
- type: textarea
attributes:
label: The spectree version
description: The output of `pip show spectree`, `uname -a`, `python --version` commands.
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
- type: markdown
attributes:
value: |
Impacted by this bug? Give it a 👍. We prioritize the issues with the most 👍.
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 @@
blank_issues_enabled: false

contact_links:
- name: Have you read the docs?
url: https://0b01001001.github.io/spectree/
about: Much help can be found in the docs
- name: Ask a question
url: https://github.com/0b01001001/spectree/discussions
about: Ask a question or start a discussion
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Feature Request
description: Feature request for spectree
labels: ["enhancement"]
title: "feat: <title>"
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this feature request!
- type: textarea
attributes:
label: Describe the feature
description: A clear and concise description of what the feature is.
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
- type: markdown
attributes:
value: |
Love this enhancement proposal? Give it a 👍. We prioritize the proposals with the most 👍.
1 change: 1 addition & 0 deletions .github/workflows/pythonpackage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
branches:
- master
- dev
merge_group:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "spectree"
version = "1.1.1"
version = "1.1.2"
dynamic = []
description = "generate OpenAPI document and validate request&response with Python annotations."
readme = "README.md"
Expand Down

0 comments on commit 65d8c1f

Please sign in to comment.