-
Notifications
You must be signed in to change notification settings - Fork 0
Dev #57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Dev #57
Changes from all commits
10de143
4063b9f
fc9347d
ed45091
965077b
4d4ebd9
67c633a
4efe6a6
c4d33ff
e18af14
96a5a0f
1219771
b518ce0
71acacc
774920e
f03c355
452f629
e4c7343
4473202
d492f3d
226fe83
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # Pull Request Description | ||
|
|
||
| > **Note**: Not all sections are required for every PR. Use only the sections that are relevant to your changes. Focus on the most important information for your specific pull request. | ||
|
|
||
| ## 📋 Overview & Changes | ||
| <!-- Provide a brief summary of what this PR accomplishes and key changes --> | ||
|
|
||
| ### 🎯 What was implemented | ||
| - [ ] Feature A | ||
| - [ ] Feature B | ||
| - [ ] Bug fix for issue C | ||
|
|
||
| ### 📝 Commit Summary | ||
| <!-- | ||
| Summary generated from commit messages and code changes: | ||
| - Key features implemented | ||
| - Bug fixes applied | ||
| - Files modified | ||
| - Breaking changes | ||
| - Performance improvements | ||
| - Code refactoring | ||
| --> | ||
|
|
||
| ### 🔧 Technical Details | ||
| <!-- Provide technical implementation details if relevant --> | ||
|
|
||
| ## 🔗 Related Tasks & Commit Analysis | ||
| <!-- Task tracking and commit analysis section --> | ||
|
|
||
| ### 🔍 Task IDs & Links from Commits | ||
| <!-- | ||
| Task IDs extracted from commit messages and their ClickUp links: | ||
| - Format: #task-id or CU-task-id | ||
| - ClickUp Link: https://app.clickup.com/t/[task-id] | ||
| - Example: #12345 → https://app.clickup.com/t/12345 | ||
| --> | ||
|
|
||
| ## 🧪 Testing | ||
| <!-- Describe how the changes were tested --> | ||
|
|
||
| - [ ] Unit tests added/updated | ||
| - [ ] Integration tests added/updated | ||
| - [ ] Manual testing completed | ||
| - [ ] Cross-browser testing (if applicable) | ||
|
|
||
| ## 🔍 Review Checklist | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👏 PRAISE: Great addition of a detailed and structured PR template! This will ✅ Resolved by CodePress Review
|
||
| <!-- Use this checklist to ensure your PR is ready for review --> | ||
|
|
||
| ### Code Quality | ||
| - [ ] Code follows project coding standards | ||
| - [ ] No console.log statements left in production code | ||
| - [ ] No hardcoded values that should be configurable | ||
| - [ ] Proper error handling implemented | ||
| - [ ] Code is properly documented | ||
|
|
||
| ### Performance | ||
| - [ ] No performance regressions introduced | ||
|
|
||
| ### Security | ||
| - [ ] No security vulnerabilities introduced | ||
| - [ ] Input validation implemented where necessary | ||
| - [ ] Sensitive data properly handled | ||
|
|
||
| ### Accessibility | ||
| - [ ] WCAG guidelines followed | ||
| - [ ] Keyboard navigation works properly | ||
| - [ ] Screen reader compatibility tested | ||
|
|
||
| ## 🚀 Deployment Notes | ||
| <!-- Any special considerations for deployment --> | ||
|
|
||
| ## 📚 Documentation | ||
| <!-- Update any relevant documentation --> | ||
|
|
||
| - [ ] README updated (if applicable) | ||
| - [ ] API documentation updated (if applicable) | ||
| - [ ] Component documentation updated (if applicable) | ||
|
|
||
| ## 🔄 Breaking Changes | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 OPTIONAL: Consider adding example entries in the Breaking Changes section to ✅ Resolved by CodePress Review
|
||
| <!-- List any breaking changes that might affect other parts of the system --> | ||
|
|
||
| ## 📋 Additional Notes | ||
| <!-- Any other information that reviewers should know --> | ||
|
|
||
| --- | ||
|
|
||
| **Template Version**: 1 | ||
| **Last Updated**: 19 Jun 2025 | ||
| **Summary Source**: Commit messages and code changes | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # https://github.com/marketplace/actions/codepress-review | ||
| # How to use: | ||
| # 1. Add the following to your PR description: | ||
| # @codepress/review | ||
|
|
||
| name: CodePress Review | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 👏 PRAISE: Great job adding the CodePress Review GitHub Actions workflow. This automated AI review integration will help maintain high code quality and consistency on pull requests. |
||
|
|
||
| on: | ||
| pull_request: | ||
| types: [] | ||
| issue_comment: | ||
| types: [created] | ||
| workflow_dispatch: # Allows manual triggering from the Actions tab | ||
|
|
||
| permissions: | ||
| pull-requests: write | ||
| contents: read | ||
| issues: read # Required to read PR comments | ||
|
|
||
| jobs: | ||
| ai-review: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout code | ||
| uses: actions/checkout@v4 | ||
| with: | ||
| fetch-depth: 0 | ||
| ref: ${{ github.event.issue.pull_request && format('refs/pull/{0}/head', github.event.issue.number) || github.ref }} | ||
|
|
||
| - name: CodePress Review | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 OPTIONAL: Consider enabling the comment trigger phrase for more flexible manual AI reviews on demand (currently disabled by run_on_comment_trigger: false). This could be helpful during ongoing PR discussions. |
||
| uses: quantfive/codepress-review@v2 | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| model_provider: "openai" | ||
| model_name: "gpt-4.1-mini-2025-04-14" | ||
| openai_api_key: ${{ secrets.OPENAI_API_KEY_FOR_PR_DESC_GENERATOR }} | ||
| # Comment triggers are enabled by default | ||
| run_on_comment_trigger: false # Disable comment triggers | ||
| # comment_trigger_phrase: "@codepress/review" # Default | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| name: Pull Request Text Generator Workflow | ||
|
|
||
| on: | ||
| pull_request_target: | ||
| types: [opened, reopened, synchronize] | ||
|
|
||
| jobs: | ||
| generate-pr-text: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Generate PR Description | ||
| uses: vblagoje/pr-auto@v1 | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 OPTIONAL: This workflow uses the secret OPENAI_API_KEY_FOR_PR_DESC_GENERATOR. Please ensure this secret is properly configured in the repository settings to prevent workflow failures. |
||
| id: pr_auto | ||
| with: | ||
| openai_api_key: ${{ secrets.OPENAI_API_KEY_FOR_PR_DESC_GENERATOR }} | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 OPTIONAL: Verify that the secret OPENAI_API_KEY_FOR_PR_DESC_GENERATOR is correctly configured in the repository settings to avoid workflow failures due to missing credentials. ✅ Resolved by CodePress Review
|
||
| system_prompt: ./custom-codepress-summary-prompt.md | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 OPTIONAL: Confirm that the referenced system prompt file 'custom-codepress-summary-prompt.md' is correctly configured and placed in the repository for the OpenAI model to generate meaningful PR descriptions. ✅ Resolved by CodePress Review
|
||
|
|
||
| - name: Update PR description | ||
| uses: vblagoje/update-pr@v1 | ||
| with: | ||
| pr-body: ${{ steps.pr_auto.outputs.pr-text }} | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,15 +12,20 @@ | |
| { | ||
| "preset": "angular", | ||
| "releaseRules": [ | ||
| {"type": "refactor", "release": "patch"} | ||
| { | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 OPTIONAL: The indentation in the "refactor" releaseRules has changed but does not add functional value. Consider cleaning formatting for consistency. ✅ Resolved by CodePress Review
|
||
| "type": "refactor", | ||
| "release": "patch" | ||
| } | ||
| ] | ||
| } | ||
| ], | ||
| "@semantic-release/release-notes-generator", | ||
| { | ||
| "path": "@semantic-release/changelog", | ||
| "condition": "branch.name === 'main'" | ||
| }, | ||
| [ | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 OPTIONAL: Introducing branch-specific changelog files (CHANGELOG.md for main, CHANGELOG-DEV.md for others) is a helpful improvement for multi-branch release workflows. ✅ Resolved by CodePress Review
|
||
| "@semantic-release/changelog", | ||
| { | ||
| "changelogFile": "${branch.name === 'main' ? 'CHANGELOG.md' : 'CHANGELOG-DEV.md'}" | ||
| } | ||
| ], | ||
| [ | ||
| "@semantic-release/npm", | ||
| { | ||
|
|
@@ -34,7 +39,7 @@ | |
| { | ||
| "assets": [ | ||
| "package.json", | ||
| "CHANGELOG.md" | ||
| "${branch.name === 'main' ? 'CHANGELOG.md' : 'CHANGELOG-DEV.md'}" | ||
| ], | ||
| "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}" | ||
| } | ||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,91 @@ | ||||||||||
| Take all below stracture to write a proper PR description | ||||||||||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🟡 OPTIONAL: Minor typo in the first line: "stracture" should be "structure".
Suggested change
✅ Resolved by CodePress Review
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔵 NIT: There is a minor typo in the first line: "stracture" should be "structure".
Suggested change
|
||||||||||
|
|
||||||||||
| # Pull Request Description | ||||||||||
|
|
||||||||||
| > **Note**: Not all sections are required for every PR. Use only the sections that are relevant to your changes. Focus on the most important information for your specific pull request. | ||||||||||
|
|
||||||||||
| ## 📋 Overview & Changes | ||||||||||
| <!-- Provide a brief summary of what this PR accomplishes and key changes --> | ||||||||||
|
|
||||||||||
| ### 🎯 What was implemented | ||||||||||
| - [ ] Feature A | ||||||||||
| - [ ] Feature B | ||||||||||
| - [ ] Bug fix for issue C | ||||||||||
|
|
||||||||||
| ### 📝 Commit Summary | ||||||||||
| <!-- | ||||||||||
| Summary generated from commit messages and code changes: | ||||||||||
| - Key features implemented | ||||||||||
| - Bug fixes applied | ||||||||||
| - Files modified | ||||||||||
| - Breaking changes | ||||||||||
| - Performance improvements | ||||||||||
| - Code refactoring | ||||||||||
| --> | ||||||||||
|
|
||||||||||
| ### 🔧 Technical Details | ||||||||||
| <!-- Provide technical implementation details if relevant --> | ||||||||||
|
|
||||||||||
| ## 🔗 Related Tasks & Commit Analysis | ||||||||||
| <!-- Task tracking and commit analysis section --> | ||||||||||
|
|
||||||||||
| ### 🔍 Task IDs & Links from Commits | ||||||||||
| <!-- | ||||||||||
| Task IDs extracted from commit messages and their ClickUp links: | ||||||||||
| - Format: #task-id or CU-task-id | ||||||||||
| - ClickUp Link: https://app.clickup.com/t/[task-id] | ||||||||||
| - Example: #12345 → https://app.clickup.com/t/12345 | ||||||||||
| --> | ||||||||||
|
|
||||||||||
| ## 🧪 Testing | ||||||||||
| <!-- Describe how the changes were tested --> | ||||||||||
|
|
||||||||||
| - [ ] Unit tests added/updated | ||||||||||
| - [ ] Integration tests added/updated | ||||||||||
| - [ ] Manual testing completed | ||||||||||
| - [ ] Cross-browser testing (if applicable) | ||||||||||
|
|
||||||||||
| ## 🔍 Review Checklist | ||||||||||
| <!-- Use this checklist to ensure your PR is ready for review --> | ||||||||||
|
|
||||||||||
| ### Code Quality | ||||||||||
| - [ ] Code follows project coding standards | ||||||||||
| - [ ] No console.log statements left in production code | ||||||||||
| - [ ] No hardcoded values that should be configurable | ||||||||||
| - [ ] Proper error handling implemented | ||||||||||
| - [ ] Code is properly documented | ||||||||||
|
|
||||||||||
| ### Performance | ||||||||||
| - [ ] No performance regressions introduced | ||||||||||
|
|
||||||||||
| ### Security | ||||||||||
| - [ ] No security vulnerabilities introduced | ||||||||||
| - [ ] Input validation implemented where necessary | ||||||||||
| - [ ] Sensitive data properly handled | ||||||||||
|
|
||||||||||
| ### Accessibility | ||||||||||
| - [ ] WCAG guidelines followed | ||||||||||
| - [ ] Keyboard navigation works properly | ||||||||||
| - [ ] Screen reader compatibility tested | ||||||||||
|
|
||||||||||
| ## 🚀 Deployment Notes | ||||||||||
| <!-- Any special considerations for deployment --> | ||||||||||
|
|
||||||||||
| ## 📚 Documentation | ||||||||||
| <!-- Update any relevant documentation --> | ||||||||||
|
|
||||||||||
| - [ ] README updated (if applicable) | ||||||||||
| - [ ] API documentation updated (if applicable) | ||||||||||
| - [ ] Component documentation updated (if applicable) | ||||||||||
|
|
||||||||||
| ## 🔄 Breaking Changes | ||||||||||
| <!-- List any breaking changes that might affect other parts of the system --> | ||||||||||
|
|
||||||||||
| ## 📋 Additional Notes | ||||||||||
| <!-- Any other information that reviewers should know --> | ||||||||||
|
|
||||||||||
| --- | ||||||||||
|
|
||||||||||
| **Template Version**: 1 | ||||||||||
| **Last Updated**: 19 Jun 2025 | ||||||||||
| **Summary Source**: Commit messages and code changes | ||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -85,4 +85,4 @@ | |
| "vite": "4.5.1", | ||
| "vue-tsc": "^0.40.4" | ||
| } | ||
| } | ||
| } | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ℹ️ FYI: This diff is a trivial formatting edit (newline removal at end of file). No functional change. Consider adding a newline at end of file for POSIX compliance and to avoid potential warnings from some tools. ✅ Resolved by CodePress Review
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🔵 NIT: Consider adding a newline at the end of this file to follow POSIX standards and avoid warnings from some tools. |
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👏 PRAISE: This is an excellent and comprehensive PR template that will greatly help contributors provide clear and structured PR descriptions, making reviews smoother and higher quality.