-
Notifications
You must be signed in to change notification settings - Fork 37
docs: update contribution guidlines, enforce security policies #15
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
Changes from all commits
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,10 @@ | ||
| language: "en-US" | ||
| reviews: | ||
| auto_review: true | ||
| # Instruct the AI to evaluate complexity and apply labels | ||
| system_prompt: > | ||
| You are an expert open-source maintainer. Analyze the code changes and the PR description. | ||
| Based on the complexity, automatically apply ONE of the following labels to the PR: | ||
| - 'complexity: basic' (for small UI tweaks, typos, simple bug fixes) | ||
| - 'complexity: intermediate' (for standard feature additions, new endpoints) | ||
| - 'complexity: high' (for major architecture changes, ML pipeline updates, complex logic) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,15 @@ | ||
| ## Summary | ||
| <!-- What does this PR do? --> | ||
| <!-- | ||
| Please ensure you have read CONTRIBUTING.md before opening a PR. | ||
| --> | ||
|
|
||
| ## Motivation | ||
| <!-- Why is this change needed? Link the related issue. Closes #<issue> --> | ||
| ## Description | ||
|
|
||
| ## Implementation Notes | ||
| <!-- How did you approach the problem? Any trade-offs or decisions worth noting? --> | ||
|
|
||
| ## Screenshots (if applicable) | ||
| <!-- Before / after screenshots for UI changes --> | ||
| <!-- Provide a clear description of what this PR does and why it is needed. Link to the relevant issue (e.g., Closes #123). If it includes UI changes, please include screenshots here. --> | ||
|
|
||
| ## Checklist | ||
| - [ ] `npm run lint` passes | ||
| - [ ] Backend tests pass (`python -m pytest backend/`) | ||
| - [ ] No `.env` files or credentials committed | ||
| - [ ] Branch is up to date with `main` | ||
| - [ ] PR description is complete | ||
|
|
||
| - [ ] `npm run lint` passes with no errors | ||
| - [ ] `npm run build` compiles without TypeScript errors | ||
| - [ ] `python -m pytest` passes (including new tests I added) | ||
|
|
||
| - [ ] No `.env` files, API keys, secrets, model weights, or `__pycache__` in this diff | ||
| - [ ] Branch is rebased on `main`, not merged | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| version: 2 | ||
| updates: | ||
| # Maintain NPM dependencies (Frontend) | ||
| - package-ecosystem: "npm" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| labels: | ||
| - "dependencies" | ||
|
|
||
| # Maintain Python dependencies (Backend) | ||
| - package-ecosystem: "pip" | ||
| directory: "/backend" | ||
| schedule: | ||
| interval: "weekly" | ||
| labels: | ||
| - "dependencies" | ||
|
|
||
| # Maintain GitHub Actions | ||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "monthly" | ||
| labels: | ||
| - "dependencies" |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| name: Greetings | ||
|
|
||
| on: | ||
| pull_request_target: | ||
| types: [opened] | ||
| issues: | ||
| types: [opened] | ||
|
|
||
| jobs: | ||
| greeting: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| issues: write | ||
| pull-requests: write | ||
| steps: | ||
| - uses: actions/first-interaction@v1 | ||
|
jpdevhub marked this conversation as resolved.
|
||
| with: | ||
| repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
|
Comment on lines
+16
to
+18
|
||
| issue-message: | | ||
| 👋 Welcome to FreshScan AI! Thank you for opening an issue. | ||
|
|
||
| Our maintainers will review this shortly. In the meantime, please ensure your report includes all necessary context and reproduction steps (if it's a bug). If this is a security issue, please close this and follow the `SECURITY.md` protocol. | ||
| pr-message: | | ||
| 🎉 Thank you for your Pull Request! We're thrilled to have your contribution to FreshScan AI. | ||
|
|
||
| Before we review, please make sure you have: | ||
| - Followed the `CONTRIBUTING.md` guidelines. | ||
| - Ensured all automated CI checks (linting, tests) are passing. | ||
| - Checked that your commit messages follow the Conventional Commits format. | ||
|
|
||
| A maintainer will review your code as soon as possible! | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| name: Stale Issue/PR Management | ||
|
|
||
| on: | ||
| schedule: | ||
| - cron: '0 0 * * *' | ||
|
|
||
| jobs: | ||
| stale: | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| issues: write | ||
| pull-requests: write | ||
| steps: | ||
| - uses: actions/stale@v9 | ||
|
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. 🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Verify unpinned GitHub Actions references in workflows.
rg -nP '^\s*-\s*uses:\s*[^@]+@((?![0-9a-f]{40}).)+$' .github/workflowsRepository: jpdevhub/FreshScanAi Length of output: 584 🏁 Script executed: #!/bin/bash
# Verify unpinned GitHub Actions references in workflows.
rg -nP '^\s*-\s*uses:\s*[^@]+@((?![0-9a-f]{40}).)+$' .github/workflowsRepository: jpdevhub/FreshScanAi Length of output: 584 🏁 Script executed: #!/bin/bash
# Verify unpinned GitHub Actions references in workflows.
rg -nP '^\s*-\s*uses:\s*[^@]+@((?![0-9a-f]{40}).)+$' .github/workflowsRepository: jpdevhub/FreshScanAi Length of output: 584 🏁 Script executed: #!/bin/bash
# Verify unpinned GitHub Actions references in workflows.
rg -nP '^\s*-\s*uses:\s*[^@]+@((?![0-9a-f]{40}).)+$' .github/workflowsRepository: jpdevhub/FreshScanAi Length of output: 584 🏁 Script executed: #!/bin/bash
# Verify unpinned GitHub Actions references in workflows.
rg -nP '^\s*-\s*uses:\s*[^@]+@((?![0-9a-f]{40}).)+$' .github/workflowsRepository: jpdevhub/FreshScanAi Length of output: 584 🏁 Script executed: #!/bin/bash
# Verify unpinned GitHub Actions references in workflows.
rg -nP '^\s*-\s*uses:\s*[^@]+@((?![0-9a-f]{40}).)+$' .github/workflowsRepository: jpdevhub/FreshScanAi Length of output: 584 🏁 Script executed: #!/bin/bash
# Verify unpinned GitHub Actions references in workflows.
rg -nP '^\s*-\s*uses:\s*[^@]+@((?![0-9a-f]{40}).)+$' .github/workflowsRepository: jpdevhub/FreshScanAi Length of output: 584 🏁 Script executed: #!/bin/bash
# Verify unpinned GitHub Actions references in workflows.
rg -nP '^\s*-\s*uses:\s*[^@]+@((?![0-9a-f]{40}).)+$' .github/workflowsRepository: jpdevhub/FreshScanAi Length of output: 584 🏁 Script executed: #!/bin/bash
# Verify unpinned GitHub Actions references in workflows.
rg -nP '^\s*-\s*uses:\s*[^@]+@((?![0-9a-f]{40}).)+$' .github/workflowsRepository: jpdevhub/FreshScanAi Length of output: 584 Pin
- uses: actions/stale@v9🔒 Proposed fix- - uses: actions/stale@v9
+ - uses: actions/stale@<FULL_LENGTH_COMMIT_SHA>🧰 Tools🪛 zizmor (1.25.2)[error] 14-14: unpinned action reference (unpinned-uses): action is not pinned to a hash (required by blanket policy) (unpinned-uses) 🤖 Prompt for AI Agents |
||
| with: | ||
| repo-token: ${{ secrets.GITHUB_TOKEN }} | ||
|
Comment on lines
+14
to
+16
|
||
| stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove the stale label or comment, otherwise this will be closed in 7 days.' | ||
| stale-pr-message: 'This PR is stale because it has been open 30 days with no activity. Remove the stale label or comment, otherwise this will be closed in 7 days.' | ||
| close-issue-message: 'This issue was closed because it has been stalled for 7 days with no activity.' | ||
| close-pr-message: 'This PR was closed because it has been stalled for 7 days with no activity.' | ||
| days-before-stale: 30 | ||
| days-before-close: 7 | ||
| exempt-issue-labels: 'bug,help wanted,needs-discussion' | ||
| exempt-pr-labels: 'dependencies' | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -39,6 +39,7 @@ __pycache__ | |
| *.pyo | ||
| *.pyd | ||
| *.egg-info | ||
| ._* | ||
|
|
||
| # Vite internals | ||
| .vite | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.