chore(github-template): clean comments and format (#1878)

This commit is contained in:
Junyi 2023-05-17 16:21:21 +07:00 committed by GitHub
parent be50cb5929
commit 7b3e16ce63
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 47 additions and 33 deletions

View File

@ -9,11 +9,11 @@ assignees: ''
## Describe the bug
A clear and concise description of what the bug is.
<!-- A clear and concise description of what the bug is. -->
## Version
NocoBase version that you are using.
<!-- NocoBase version that you are using. -->
## How To Reproduce
@ -26,16 +26,16 @@ Steps to reproduce the behavior:
## Expected behavior
A clear and concise description of what you expected to happen.
<!-- A clear and concise description of what you expected to happen. -->
## Screenshots
If applicable, add screenshots to help explain your problem.
<!-- If applicable, add screenshots to help explain your problem. -->
## Desktop (please complete the following information)
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
- Browser [e.g. chrome v102, safari]
## Smartphone (please complete the following information)
@ -46,4 +46,4 @@ If applicable, add screenshots to help explain your problem.
## Additional context
Add any other context about the problem here.
<!-- Add any other context about the problem here. -->

View File

@ -1,19 +1,25 @@
# Description (Bug描述
## Description (Bug 描述)
## Steps to reproduce (复现步骤)
Clear steps to reproduce the bug.
### Steps to reproduce (复现步骤)
## Expected behavior (预期行为)
Describe what the expected behavior should be when the code is executed without the bug.
<!-- Clear steps to reproduce the bug. -->
## Actual behavior (实际行为)
Describe what actually happens when the code is executed with the bug.
### Expected behavior (预期行为)
<!--- Describe what the expected behavior should be when the code is executed without the bug. -->
### Actual behavior (实际行为)
<!-- Describe what actually happens when the code is executed with the bug. -->
## Related issues (相关 issue)
Include any related issues or previous bug reports related to this bug.
# Reason (原因)
Explain what caused the bug to occur.
<!-- Include any related issues or previous bug reports related to this bug. -->
# Solution (解决方案)
Describe solution to the bug clearly and consciously.
## Reason (原因)
<!-- Explain what caused the bug to occur. -->
## Solution (解决方案)
<!-- Describe solution to the bug clearly and consciously. -->

View File

@ -1,20 +1,28 @@
# Description (需求描述)
Describe the new feature or modification to an existing feature clearly and consciously.
## Description (需求描述)
# Motivation (需求背景)
Explain the reason for adding or modifying this feature.
<!-- Describe the new feature or modification to an existing feature clearly and consciously. -->
## Motivation (需求背景)
<!-- Explain the reason for adding or modifying this feature. -->
## Key changes (关键改动)
<!-- Provide a technically detailed description of the key changes made. -->
# Key changes (关键改动)
Provide a technically detailed description of the key changes made.
- Frontend (前端)
- Backend (后端)
# Test plan (测试计划)
## Suggestions (测试建议)
Provide any suggestions or recommendations for improvements in the testing plan.
## Test plan (测试计划)
## Underlying risk (潜在风险)
Identify any potential risks or issues that may arise from the new feature or modification.
### Suggestions (测试建议)
# Showcase (结果展示)
Including any screenshots of the new feature or modification.
<!-- Provide any suggestions or recommendations for improvements in the testing plan. -->
### Underlying risk (潜在风险)
<!-- Identify any potential risks or issues that may arise from the new feature or modification. -->
## Showcase (结果展示)
<!-- Including any screenshots of the new feature or modification. -->