Skip to content

Conversation

killerlux
Copy link
Contributor

@killerlux killerlux commented May 3, 2025

This PR adds: SECURITY.md (security policy), Pull request template, Feature request and question issue templates. No code of conduct included as requested. Ready for review and merge.

Summary by Sourcery

Add project governance and community support files to improve project documentation and contribution guidelines

Enhancements:

  • Improved video capture device detection with more verbose logging
  • Added CPU execution provider handling
  • Enhanced camera initialization diagnostics

Documentation:

  • Added comprehensive README installation instructions for Linux
  • Added security policy document
  • Created pull request and issue templates to guide contributions

Chores:

  • Added GitHub issue templates for feature requests and questions
  • Created pull request template to standardize contribution process

Copy link
Contributor

sourcery-ai bot commented May 3, 2025

Reviewer's Guide

This pull request introduces community health files (PR template, issue templates, security policy) by adding new markdown files under the .github/ directory. It also improves the setup and execution experience by updating the README with Linux instructions and CPU usage details, refining camera detection logic in video_capture.py with added logging, and ensuring GPU resources are disabled in core.py when CPU execution is specified.

File-Level Changes

Change Details Files
Add community health files (PR/Issue templates, Security Policy).
  • Added a standard pull request template.
  • Added an issue template for feature requests.
  • Added an issue template for questions.
  • Added a security policy file (SECURITY.md).
.github/PULL_REQUEST_TEMPLATE.md
.github/ISSUE_TEMPLATE/feature_request.md
.github/ISSUE_TEMPLATE/question.md
.github/SECURITY.md
Improve setup instructions and CPU execution handling.
  • Added detailed Linux (Debian/Ubuntu) setup instructions to README.
  • Updated README run command to include CPU execution provider flag.
  • Added logic to disable CUDA environment variables and clear cache when CPU provider is explicitly used.
README.md
modules/core.py
Enhance camera device detection and initialization logging.
  • Modified camera opening logic to try multiple device indices and backends (especially for Linux).
  • Added verbose print statements during camera device probing and opening.
  • Added print statement to show actual camera settings (resolution, FPS) after successful initialization.
modules/video_capture.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @killerlux - I've reviewed your changes - here's some feedback:

  • Consider separating the repository configuration changes (templates, security policy) from the code changes into distinct pull requests.
  • Remove the debugging print statements added in modules/video_capture.py before merging.
  • Update the placeholder email address in SECURITY.md.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.


## Reporting a Vulnerability

If you discover a security vulnerability, please report it by emailing the project maintainers at [[email protected]].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚨 issue (security): Replace placeholder email address.

Provide the actual email address for reporting vulnerabilities.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant