diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..186a39d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve CodeLens +title: 'bug: ' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +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] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..29f4445 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for CodeLens +title: 'feat: ' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/labeler.yml b/.github/labeler.yml new file mode 100644 index 0000000..af623c4 --- /dev/null +++ b/.github/labeler.yml @@ -0,0 +1,19 @@ +# Configuration for actions/labeler + +area/frontend: + - changed-files: + - any-glob-to-any-file: 'frontend/**/*' + +area/backend: + - changed-files: + - any-glob-to-any-file: 'server/**/*' + +area/documentation: + - changed-files: + - any-glob-to-any-file: + - '**/*.md' + - 'docs/**/*' + +area/workflows: + - changed-files: + - any-glob-to-any-file: '.github/workflows/**/*' diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 5301dc0..a59b9dc 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,76 +1,28 @@ -# ๐Ÿ“Œ Pull Request Summary +# Description -## ๐Ÿ”— Related Issue +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. -Closes # +Fixes # (issue) ---- +## Type of Change -## ๐Ÿ“ Description +- [ ] 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) +- [ ] Documentation update -Provide a clear and concise summary of the changes made in this pull request. +# How Has This Been Tested? -### Changes Made +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. -* -* -* +- [ ] Test A +- [ ] Test B -### Motivation - -Explain why these changes were necessary and what problem they solve. - ---- - -## ๐Ÿš€ Type of Change - -Select all that apply: - -* [ ] Bug Fix -* [ ] New Feature -* [ ] Enhancement -* [ ] Documentation Update -* [ ] Refactoring -* [ ] Performance Improvement -* [ ] DevOps / Tooling -* [ ] Other - ---- - -## ๐Ÿงช Testing - -### Verification - -* [ ] Tested Locally -* [ ] Existing Tests Passed -* [ ] New Tests Added -* [ ] No Testing Required - -### Test Details - -Describe how the changes were tested and verified. - ---- - -## ๐Ÿ“ธ Screenshots / Demo (If Applicable) - -Attach screenshots, GIFs, or recordings that help demonstrate the changes. - ---- - -## โœ… Checklist - -* [ ] I have read and followed the contribution guidelines. -* [ ] I have self-reviewed my changes. -* [ ] My changes are limited to the scope of this issue. -* [ ] Documentation has been updated where necessary. -* [ ] No unnecessary files or unrelated changes have been included. -* [ ] The related issue has been linked correctly. -* [ ] All applicable testing and validation steps have been completed. - ---- - -## ๐Ÿ“š Additional Notes - -Add any additional information that may help reviewers. +# Checklist +- [ ] My code follows the style guidelines of this project +- [ ] I have performed a self-review of my own code +- [ ] I have commented my code, particularly in hard-to-understand areas +- [ ] I have made corresponding changes to the documentation +- [ ] My changes generate no new warnings +- [ ] Any dependent changes have been merged and published in downstream modules diff --git a/.github/workflows/auto-labeler.yml b/.github/workflows/auto-labeler.yml new file mode 100644 index 0000000..d9081be --- /dev/null +++ b/.github/workflows/auto-labeler.yml @@ -0,0 +1,20 @@ +name: PR Auto Labeler + +on: + pull_request_target: + types: [opened, synchronized] + +jobs: + label: + name: Auto Label PR + runs-on: ubuntu-latest + permissions: + contents: read + pull-requests: write + steps: + - name: Apply labels + uses: actions/labeler@v5 + with: + repo-token: "${{ secrets.GITHUB_TOKEN }}" + configuration-path: ".github/labeler.yml" + sync-labels: true