|
|
@@ -1,34 +1,32 @@
|
|
|
-# Checklist:
|
|
|
-
|
|
|
-> [!IMPORTANT]
|
|
|
-> Please review the checklist below before submitting your pull request.
|
|
|
-
|
|
|
-- [ ] Please open an issue before creating a PR or link to an existing issue
|
|
|
-- [ ] I have performed a self-review of my own code
|
|
|
-- [ ] I have commented my code, particularly in hard-to-understand areas
|
|
|
-- [ ] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods
|
|
|
-
|
|
|
-# Description
|
|
|
+# Summary
|
|
|
|
|
|
-Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue. Close issue syntax: `Fixes #<issue number>`, see [documentation](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) for more details.
|
|
|
+Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
|
|
|
|
|
|
-Fixes
|
|
|
+> [!INFO]
|
|
|
+> Tips: Close issue syntax: `Fixes #<issue number>` or `Resolves #<issue number>`, see [documentation](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) for more details.
|
|
|
|
|
|
-## Type of Change
|
|
|
|
|
|
-- [ ] Bug fix (non-breaking change which fixes an issue)
|
|
|
-- [ ] New feature (non-breaking change which adds functionality)
|
|
|
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
|
|
-- [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs)
|
|
|
-- [ ] Improvement, including but not limited to code refactoring, performance optimization, and UI/UX improvement
|
|
|
-- [ ] Dependency upgrade
|
|
|
-
|
|
|
-# Testing Instructions
|
|
|
+# Screenshots
|
|
|
|
|
|
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
|
|
|
+<table>
|
|
|
+ <tr>
|
|
|
+ <td>Before: </td>
|
|
|
+ <td>After: </td>
|
|
|
+ </tr>
|
|
|
+ <tr>
|
|
|
+ <td>...</td>
|
|
|
+ <td>...</td>
|
|
|
+ </tr>
|
|
|
+</table>
|
|
|
|
|
|
-- [ ] Test A
|
|
|
-- [ ] Test B
|
|
|
+# Checklist:
|
|
|
|
|
|
+> [!IMPORTANT]
|
|
|
+> Please review the checklist below before submitting your pull request.
|
|
|
|
|
|
+- [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs)
|
|
|
+- [x] I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
|
|
|
+- [x] I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
|
|
|
+- [x] I've updated the documentation accordingly.
|
|
|
+- [x] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods
|
|
|
|
crazywoola