新增issue模版

This commit is contained in:
Liujian
2022-03-25 11:37:34 +08:00
parent 89d4c64f44
commit 8e2fc3408c
10 changed files with 160 additions and 0 deletions

View File

@@ -0,0 +1,63 @@
name: "Bug Report"
description: Report a bug to help improve the project.
title: "bug: "
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report this bug!
_The more information you share, the faster we can identify and fix the bug._
Prior to opening the issue, please make sure that you:
- Use English to communicate.
- Search the [open issues](https://github.com/eolinker/apinto/issues) and [discussion forum](https://github.com/eolinker/apinto/discussions) to avoid duplicating the issue.
- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: Describe the issue you are facing.
placeholder: |
What is the issue with the current behavior?
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Describe what you expected to happen.
placeholder: |
What did you expect to happen instead?
validations:
required: false
- type: textarea
id: error
attributes:
label: Error Logs
description: Paste the error logs if any.
validations:
required: false
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: Share the steps you took so that we can reproduce the issue. Reports without proper steps details will likely be closed.
placeholder: |
1. Run apinto via the Docker image.
2. Create a Route with the Admin API.
3. Try configuring ...
4. ...
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Share your environment details. Reports without proper environment details will likely be closed.
value: |
- APINTO version (run `apinto version`):
- Operating system (run `uname -a`):
validations:
required: true

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: APINTO Discussion Forum
url: https://github.com/eolinker/apinto/discussions
about: Please ask and answer questions here.

View File

@@ -0,0 +1,33 @@
name: "Documentation Issue"
description: Issues related to documentation.
title: "docs: "
labels: [doc]
body:
- type: markdown
attributes:
value: |
_The more information you share, the faster we can help you._
Prior to opening the issue, please make sure that you:
- Use English to communicate.
- Search the [open issues](https://github.com/eolinker/apinto/issues) and [discussion forum](https://github.com/eolinker/apinto/discussions) to avoid duplicating the issue.
- type: textarea
id: current-state
attributes:
label: Current State
description: Describe the current state of the documentation.
placeholder: |
The documentation for the API in this page (url) is missing ...
validations:
required: true
- type: textarea
id: desired-state
attributes:
label: Desired State
description: Describe the desired state the documentation should be in.
placeholder: |
There should be line mentioning how the API behaves when ...
validations:
required: true

View File

@@ -0,0 +1,23 @@
name: "Feature Request"
description: Suggest an enhancement to APINTO.
title: "feat: As a user, I want to ..., so that ..."
body:
- type: markdown
attributes:
value: |
_The more information you share, the faster we can help you._
Prior to opening the issue, please make sure that you:
- Use English to communicate.
- Search the [open issues](https://github.com/eolinker/apinto/issues) and [discussion forum](https://github.com/eolinker/apinto/discussions) to avoid duplicating the issue.
- type: textarea
id: description
attributes:
label: Description
description: Describe the feature you would like to see.
placeholder: |
As a user, I want to ..., so that...
validations:
required: true

View File

@@ -0,0 +1,31 @@
name: "Request Help"
description: Stuck? Ask for help!
title: "help request: "
body:
- type: markdown
attributes:
value: |
_The more information you share, the faster we can help you._
Prior to opening the issue, please make sure that you:
- Use English to communicate.
- Search the [open issues](https://github.com/eolinker/apinto/issues) and [discussion forum](https://github.com/eolinker/apinto/discussions) to avoid duplicating the issue.
- type: textarea
id: description
attributes:
label: Description
description: Describe the issue you are facing and what you need help with.
validations:
required: true
- type: textarea
id: environment
attributes:
label: Environment
description: Share your environment details. Reports without proper environment details will likely be closed.
value: |
- APINTO version (run `apinto version`):
- Operating system (run `uname -a`):
validations:
required: true

1
.gitignore vendored
View File

@@ -16,3 +16,4 @@
/.idea/
/vendor/
/go.sum
*.DS_Store

1
build/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
*.DS_Store

1
drivers/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
*.DS_Store

1
node/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
*.DS_Store

1
output/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
*.DS_Store