mirror of
https://github.com/nocobase/nocobase
synced 2024-11-15 06:46:38 +00:00
chore(github-template): clean comments and format (#1878)
This commit is contained in:
parent
be50cb5929
commit
7b3e16ce63
14
.github/ISSUE_TEMPLATE/bug_report.md
vendored
14
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -9,11 +9,11 @@ assignees: ''
|
|||||||
|
|
||||||
## Describe the bug
|
## Describe the bug
|
||||||
|
|
||||||
A clear and concise description of what the bug is.
|
<!-- A clear and concise description of what the bug is. -->
|
||||||
|
|
||||||
## Version
|
## Version
|
||||||
|
|
||||||
NocoBase version that you are using.
|
<!-- NocoBase version that you are using. -->
|
||||||
|
|
||||||
## How To Reproduce
|
## How To Reproduce
|
||||||
|
|
||||||
@ -26,16 +26,16 @@ Steps to reproduce the behavior:
|
|||||||
|
|
||||||
## Expected 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
|
## 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)
|
## Desktop (please complete the following information)
|
||||||
|
|
||||||
- OS: [e.g. iOS]
|
- OS: [e.g. iOS]
|
||||||
- Browser [e.g. chrome, safari]
|
- Browser [e.g. chrome v102, safari]
|
||||||
- Version [e.g. 22]
|
|
||||||
|
|
||||||
## Smartphone (please complete the following information)
|
## Smartphone (please complete the following information)
|
||||||
|
|
||||||
@ -46,4 +46,4 @@ If applicable, add screenshots to help explain your problem.
|
|||||||
|
|
||||||
## Additional context
|
## Additional context
|
||||||
|
|
||||||
Add any other context about the problem here.
|
<!-- Add any other context about the problem here. -->
|
||||||
|
32
.github/PULL_REQUEST_TEMPLATE/bug_fix.md
vendored
32
.github/PULL_REQUEST_TEMPLATE/bug_fix.md
vendored
@ -1,19 +1,25 @@
|
|||||||
# Description (Bug描述)
|
## Description (Bug 描述)
|
||||||
|
|
||||||
## Steps to reproduce (复现步骤)
|
### Steps to reproduce (复现步骤)
|
||||||
Clear steps to reproduce the bug.
|
|
||||||
|
|
||||||
## Expected behavior (预期行为)
|
<!-- Clear steps to reproduce the bug. -->
|
||||||
Describe what the expected behavior should be when the code is executed without the bug.
|
|
||||||
|
|
||||||
## Actual behavior (实际行为)
|
### Expected behavior (预期行为)
|
||||||
Describe what actually happens when the code is executed with the bug.
|
|
||||||
|
|
||||||
## Related issues (相关issue)
|
<!--- Describe what the expected behavior should be when the code is executed without the bug. -->
|
||||||
Include any related issues or previous bug reports related to this bug.
|
|
||||||
|
|
||||||
# Reason (原因)
|
### Actual behavior (实际行为)
|
||||||
Explain what caused the bug to occur.
|
|
||||||
|
|
||||||
# Solution (解决方案)
|
<!-- Describe what actually happens when the code is executed with the bug. -->
|
||||||
Describe solution to the bug clearly and consciously.
|
|
||||||
|
## Related issues (相关 issue)
|
||||||
|
|
||||||
|
<!-- Include any related issues or previous bug reports related to this bug. -->
|
||||||
|
|
||||||
|
## Reason (原因)
|
||||||
|
|
||||||
|
<!-- Explain what caused the bug to occur. -->
|
||||||
|
|
||||||
|
## Solution (解决方案)
|
||||||
|
|
||||||
|
<!-- Describe solution to the bug clearly and consciously. -->
|
||||||
|
34
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
34
.github/PULL_REQUEST_TEMPLATE/feature.md
vendored
@ -1,20 +1,28 @@
|
|||||||
# Description (需求描述)
|
## Description (需求描述)
|
||||||
Describe the new feature or modification to an existing feature clearly and consciously.
|
|
||||||
|
|
||||||
# Motivation (需求背景)
|
<!-- Describe the new feature or modification to an existing feature clearly and consciously. -->
|
||||||
Explain the reason for adding or modifying this feature.
|
|
||||||
|
## 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 (前端)
|
- Frontend (前端)
|
||||||
- Backend (后端)
|
- Backend (后端)
|
||||||
|
|
||||||
# Test plan (测试计划)
|
## Test plan (测试计划)
|
||||||
## Suggestions (测试建议)
|
|
||||||
Provide any suggestions or recommendations for improvements in the testing plan.
|
|
||||||
|
|
||||||
## Underlying risk (潜在风险)
|
### Suggestions (测试建议)
|
||||||
Identify any potential risks or issues that may arise from the new feature or modification.
|
|
||||||
|
|
||||||
# Showcase (结果展示)
|
<!-- Provide any suggestions or recommendations for improvements in the testing plan. -->
|
||||||
Including any screenshots of the new feature or modification.
|
|
||||||
|
### 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. -->
|
||||||
|
Loading…
Reference in New Issue
Block a user