chore: template

This commit is contained in:
weidong fu
2025-01-08 13:40:13 +08:00
parent 9971061222
commit dce880fea9
4 changed files with 10152 additions and 7801 deletions

61
.github/ISSUE_TEMPLATE/bug_report.yaml vendored Normal file
View File

@@ -0,0 +1,61 @@
name: Bug Report
description: Report a bug in the AppFlowy Web
title: "[Bug] "
body:
- type: textarea
id: bug_desc
attributes:
label: Bug Description
description: "Provide a clear and concise description of the issue you encountered in AppFlowy Web."
validations:
required: true
- type: textarea
id: steps_to_reproduce
attributes:
label: Steps to Reproduce
description: "List the steps to reproduce the bug in AppFlowy Web. Include specific details like page interactions, actions, or conditions."
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: Expected Behavior
description: "What behavior did you expect instead of the bug? Please be clear and concise."
validations:
required: true
- type: input
id: browser
attributes:
label: Browser and Version
description: "Specify the browser and its version where the bug was observed (e.g., Chrome 112, Firefox 98)."
validations:
required: true
- type: input
id: appflowy_version
attributes:
label: AppFlowy Version(s)
description: "Specify the version(s) of AppFlowy Web where this bug was encountered (e.g., v0.10.1)."
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: "If applicable, include screenshots to help explain the issue. Provide URLs or attach files."
- type: textarea
id: logs
attributes:
label: Logs and Console Output
description: "Include any relevant logs or browser console output that could help diagnose the issue."
- type: textarea
id: additional_context
attributes:
label: Additional Context
description: "Provide any additional information about the issue, including specific modules, plugins, or configurations."

View File

@@ -0,0 +1,39 @@
name: Feature Request
description: Suggest a new feature or enhancement for the AppFlowy Web
title: "[Feature Request] "
body:
- type: textarea
id: feature_description
attributes:
label: Feature Description
description: "Describe the feature you'd like to see in AppFlowy Web. Include its purpose, functionality, and how it would improve the user experience."
validations:
required: true
- type: textarea
id: use_cases
attributes:
label: Use Cases
description: "Provide specific examples or scenarios where this feature would be helpful. How will it be used in real-world situations?"
validations:
required: true
- type: textarea
id: user_impact
attributes:
label: User Impact
description: "Explain the types of users (e.g., developers, designers, managers) who would benefit from this feature. Highlight how it addresses their needs."
validations:
required: true
- type: textarea
id: potential_implementation
attributes:
label: Potential Implementation Ideas
description: "If you have thoughts on how this feature could be implemented, share them here. Include technical or design ideas, if applicable."
- type: textarea
id: additional_context
attributes:
label: Additional Context
description: "Provide any other relevant context, references, or links that could help us understand or evaluate your suggestion."

59
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View File

@@ -0,0 +1,59 @@
<!---
Thank you for submitting a pull request to the AppFlowy Web! The team will dedicate their best efforts to reviewing and approving your PR. If you have any questions or feedback, feel free to join our [Discord](https://discord.gg/wdjWUXXhtw).
-->
### **Feature Preview (Optional)**
<!---
If your pull request introduces a new feature for AppFlowy Web, please attach a video or screenshot showcasing your work. Drag and drop files into this section.
If this is not a feature PR, feel free to delete this section.
-->
---
### **Related Issues**
<!---
List at least one issue that this PR addresses. If it resolves the issue, use the [fixes](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests) keyword to automatically close it. Example:
fixes #2106
-->
---
### **Description**
<!---
Provide a clear and concise description of the changes introduced in this pull request for AppFlowy Web. What problem does it solve? What value does it add?
-->
---
### **Technical Implementation (Optional)**
<!---
If applicable, provide technical details about the implementation. Explain any design decisions, trade-offs, or alternatives considered for AppFlowy Web.
-->
---
### **Checklist**
<!---
Before marking your pull request as ready for review, ensure the following checklist is complete.
-->
#### **General**
- [ ] At least one issue this PR fixes is listed in the "Related Issues" section.
- [ ] The code adheres to the AppFlowy Web project's style guidelines.
- [ ] I've included relevant documentation or comments for the changes introduced.
- [ ] I've tested the changes in multiple environments (e.g., different browsers, operating systems).
#### **Testing**
- [ ] I've added or updated tests to validate the changes introduced for AppFlowy Web.
- [ ] All existing tests are passing.
#### **Feature-Specific**
- [ ] For feature additions, I've added a preview (video, screenshot, or demo) in the "Feature Preview" section.
- [ ] I've verified that this feature integrates seamlessly with existing functionality.
---
### **Notes for Reviewers (Optional)**
<!---
Add any notes for reviewers, such as areas to focus on, known issues, or questions youd like feedback on.
-->

17794
pnpm-lock.yaml generated
View File

File diff suppressed because it is too large Load Diff