mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-11-29 04:10:09 +08:00
Converted issues templates to forms
Added support request template
This commit is contained in:
parent
7ad98fc3c3
commit
5d6d7ef5a7
17
.github/ISSUE_TEMPLATE/api_request.md
vendored
17
.github/ISSUE_TEMPLATE/api_request.md
vendored
|
@ -1,17 +0,0 @@
|
||||||
---
|
|
||||||
name: New API Endpoint or Feature
|
|
||||||
about: Request a new endpoint or API feature be added
|
|
||||||
labels: ":nut_and_bolt: API Request"
|
|
||||||
---
|
|
||||||
|
|
||||||
#### API Endpoint or Feature
|
|
||||||
|
|
||||||
Clearly describe what you'd like to have added to the API.
|
|
||||||
|
|
||||||
#### Use-Case
|
|
||||||
|
|
||||||
Explain the use-case that you're working-on that requires the above request.
|
|
||||||
|
|
||||||
#### Additional Context
|
|
||||||
|
|
||||||
If required, add any other context about the feature request here.
|
|
26
.github/ISSUE_TEMPLATE/api_request.yml
vendored
Normal file
26
.github/ISSUE_TEMPLATE/api_request.yml
vendored
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
name: New API Endpoint or API Ability
|
||||||
|
description: Request a new endpoint or API feature be added
|
||||||
|
title: "[API Request]: "
|
||||||
|
labels: [":nut_and_bolt: API Request"]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: feature
|
||||||
|
attributes:
|
||||||
|
label: API Endpoint or Feature
|
||||||
|
description: Clearly describe what you'd like to have added to the API.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: usecase
|
||||||
|
attributes:
|
||||||
|
label: Use-Case
|
||||||
|
description: Explain the use-case that you're working-on that requires the above request.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: context
|
||||||
|
attributes:
|
||||||
|
label: Additional context
|
||||||
|
description: Add any other context about the feature request here.
|
||||||
|
validations:
|
||||||
|
required: false
|
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
29
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -1,29 +0,0 @@
|
||||||
---
|
|
||||||
name: Bug Report
|
|
||||||
about: Create a report to help us improve
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Describe the bug**
|
|
||||||
A clear and concise description of what the bug is.
|
|
||||||
|
|
||||||
**Steps To Reproduce**
|
|
||||||
Steps to reproduce the behavior:
|
|
||||||
1. Go to '...'
|
|
||||||
2. Click on '....'
|
|
||||||
3. Scroll down to '....'
|
|
||||||
4. See error
|
|
||||||
|
|
||||||
**Expected behavior**
|
|
||||||
A clear and concise description of what you expected to happen.
|
|
||||||
|
|
||||||
**Screenshots**
|
|
||||||
If applicable, add screenshots to help explain your problem.
|
|
||||||
|
|
||||||
**Your Configuration (please complete the following information):**
|
|
||||||
- Exact BookStack Version (Found in settings):
|
|
||||||
- PHP Version:
|
|
||||||
- Hosting Method (Nginx/Apache/Docker):
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context about the problem here.
|
|
62
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
62
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
@ -0,0 +1,62 @@
|
||||||
|
name: Bug Report
|
||||||
|
description: Create a report to help us improve or fix things
|
||||||
|
title: "[Bug Report]: "
|
||||||
|
labels: [":bug: Bug"]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Describe the Bug
|
||||||
|
description: Provide a clear and concise description of what the bug is.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: reproduction
|
||||||
|
attributes:
|
||||||
|
label: Steps to Reproduce
|
||||||
|
description: Detail the steps that would replicate this issue
|
||||||
|
placeholder: |
|
||||||
|
1. Go to '...'
|
||||||
|
2. Click on '....'
|
||||||
|
3. Scroll down to '....'
|
||||||
|
4. See error
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: expected
|
||||||
|
attributes:
|
||||||
|
label: Expected Behaviour
|
||||||
|
description: Provide clear and concise description of what you expected to happen.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: context
|
||||||
|
attributes:
|
||||||
|
label: Screenshots or Additional Context
|
||||||
|
description: Provide any additional context and screenshots here to help us solve this issue
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: bsversion
|
||||||
|
attributes:
|
||||||
|
label: Exact BookStack Version
|
||||||
|
description: This can be found in the settings view of BookStack. Please provide an exact version.
|
||||||
|
placeholder: (eg. v21.08.5)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: phpversion
|
||||||
|
attributes:
|
||||||
|
label: PHP Version
|
||||||
|
description: Keep in mind your command-line PHP version may differ to that of your webserver. Provide that relevant to the issue.
|
||||||
|
placeholder: (eg. 7.4)
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: hosting
|
||||||
|
attributes:
|
||||||
|
label: Hosting Environment
|
||||||
|
description: Describe your hosting environment as much as possible including any proxies used (If applicable).
|
||||||
|
placeholder: (eg. Ubuntu 20.04 VPS, installed using official installation script)
|
||||||
|
validations:
|
||||||
|
required: true
|
14
.github/ISSUE_TEMPLATE/feature_request.md
vendored
14
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -1,14 +0,0 @@
|
||||||
---
|
|
||||||
name: Feature Request
|
|
||||||
about: Suggest an idea for this project
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
**Describe the feature you'd like**
|
|
||||||
A clear description of the feature you'd like implemented in BookStack.
|
|
||||||
|
|
||||||
**Describe the benefits this feature would bring to BookStack users**
|
|
||||||
Explain the measurable benefits this feature would achieve.
|
|
||||||
|
|
||||||
**Additional context**
|
|
||||||
Add any other context or screenshots about the feature request here.
|
|
26
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
26
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
name: Feature Request
|
||||||
|
description: Request a new language to be added to CrowdIn for you to translate
|
||||||
|
title: "[Feature Request]: "
|
||||||
|
labels: [":hammer: Feature Request"]
|
||||||
|
body:
|
||||||
|
- type: textarea
|
||||||
|
id: description
|
||||||
|
attributes:
|
||||||
|
label: Describe the feature you'd like
|
||||||
|
description: Provide a clear description of the feature you'd like implemented in BookStack
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: benefits
|
||||||
|
attributes:
|
||||||
|
label: Describe the benefits this feature would bring to BookStack users
|
||||||
|
description: Explain the measurable benefits this feature would achieve for existing BookStack users
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: context
|
||||||
|
attributes:
|
||||||
|
label: Additional context
|
||||||
|
description: Add any other context or screenshots about the feature request here.
|
||||||
|
validations:
|
||||||
|
required: false
|
63
.github/ISSUE_TEMPLATE/support_request.yml
vendored
Normal file
63
.github/ISSUE_TEMPLATE/support_request.yml
vendored
Normal file
|
@ -0,0 +1,63 @@
|
||||||
|
name: Support Request
|
||||||
|
description: Request support for a specific problem you have not been able to solve
|
||||||
|
title: "[Support Request]: "
|
||||||
|
labels: [":dog2: Support"]
|
||||||
|
body:
|
||||||
|
- type: checkboxes
|
||||||
|
id: useddocs
|
||||||
|
attributes:
|
||||||
|
label: Attempted Debugging
|
||||||
|
description: |
|
||||||
|
I have read the [BookStack debugging](https://www.bookstackapp.com/docs/admin/debugging/) page and seeked resolution or more
|
||||||
|
detail for the issue.
|
||||||
|
options:
|
||||||
|
- label: I have read the debugging page
|
||||||
|
required: true
|
||||||
|
- type: checkboxes
|
||||||
|
id: searchissue
|
||||||
|
attributes:
|
||||||
|
label: Searched GitHub Issues
|
||||||
|
description: |
|
||||||
|
I have searched for the issue and potential resolutions within the [project's GitHub issue list](https://github.com/BookStackApp/BookStack/issues)
|
||||||
|
options:
|
||||||
|
- label: I have searched GitHub for the issue.
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: scenario
|
||||||
|
attributes:
|
||||||
|
label: Describe the Scenario
|
||||||
|
description: Detail the problem that you're having or what you need support with.
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: input
|
||||||
|
id: bsversion
|
||||||
|
attributes:
|
||||||
|
label: Exact BookStack Version
|
||||||
|
description: This can be found in the settings view of BookStack. Please provide an exact version.
|
||||||
|
placeholder: (eg. v21.08.5)
|
||||||
|
validations:
|
||||||
|
required: true
|
||||||
|
- type: textarea
|
||||||
|
id: logs
|
||||||
|
attributes:
|
||||||
|
label: Log Content
|
||||||
|
description: If the issue has produced an error, provide any [BookStack or server log](https://www.bookstackapp.com/docs/admin/debugging/) content below.
|
||||||
|
placeholder: Be sure to remove any confidential details in your logs
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: input
|
||||||
|
id: phpversion
|
||||||
|
attributes:
|
||||||
|
label: PHP Version
|
||||||
|
description: Keep in mind your command-line PHP version may differ to that of your webserver. Provide that relevant to the issue.
|
||||||
|
placeholder: (eg. 7.4)
|
||||||
|
validations:
|
||||||
|
required: false
|
||||||
|
- type: textarea
|
||||||
|
id: hosting
|
||||||
|
attributes:
|
||||||
|
label: Hosting Environment
|
||||||
|
description: Describe your hosting environment as much as possible including any proxies used (If applicable).
|
||||||
|
placeholder: (eg. Ubuntu 20.04 VPS, installed using official installation script)
|
||||||
|
validations:
|
||||||
|
required: true
|
Loading…
Reference in New Issue
Block a user