Skip to content

feat: add CONTRIBUTING, LICENSE, SECURITY, tests, requirements - #8

Open
itsdarklikehell wants to merge 2 commits into
masterfrom
feat/docs-security-tests
Open

itsdarklikehell wants to merge 2 commits into
masterfrom
feat/docs-security-tests

Conversation

@itsdarklikehell

@itsdarklikehell itsdarklikehell commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator

Changes

  • Add CONTRIBUTING.md with contribution guidelines
  • Add MIT LICENSE
  • Add SECURITY.md with security policy
  • Add test suite
  • Add requirements.txt (where missing)

Summary by Sourcery

Establish the project’s contribution, licensing, security, dependency, and automated testing foundations.

Enhancements:

  • Add repository contribution and security policies and establish MIT licensing.
  • Add an automated pytest suite covering plugin syntax, structure, and required project files.

Build:

  • Add a requirements.txt dependency manifest.

Documentation:

  • Add contributor guidelines, security vulnerability reporting guidance, and an MIT license.

Tests:

  • Introduce pytest coverage for plugin parsing, compilation, metadata, lifecycle methods, and repository configuration.

@sourcery-ai

sourcery-ai Bot commented Oct 6, 2026

Copy link
Copy Markdown

Sorry @itsdarklikehell, you've used your own review budget of 250,000 diff characters for the last 7 days.

You can request another review in 8 hours and 21 minutes by commenting @sourcery-ai review. Upgrade to get a review now.

@coderabbitai

coderabbitai Bot commented Oct 6, 2026

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 099b46c1-ebda-4dd3-a45a-7001b415806b
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Your trial has ended. Reactivate Greptile to resume code reviews.

@sourcery-ai

sourcery-ai Bot commented Oct 6, 2026

Copy link
Copy Markdown

Reviewer's Guide

This PR establishes contribution, licensing, and security documentation, adds a requirements manifest, and introduces pytest-based smoke tests that mock the pwnagotchi environment to validate syntax, plugin structure, and required repository files.

Flow diagram for the new pytest smoke tests

flowchart TD
    A[pytest test_pwnsorter.py] --> B[Mock pwnagotchi environment]
    B --> C[Validate pwnsorter syntax]
    B --> D[Validate plugin structure]
    A --> E[Validate required repository files]
Loading

File-Level Changes

Change Details Files
Adds repository governance and security documentation.
  • Documents the fork, branch, commit, pull request, coding-style, testing, and issue-reporting workflows.
  • Adds the MIT license.
  • Defines supported-version and vulnerability-reporting policies, directing private reports to GitHub Security Advisories.
CONTRIBUTING.md
LICENSE
SECURITY.md
Introduces lightweight automated validation for the plugin and repository layout.
  • Adds AST parsing and bytecode compilation checks for the main Python plugin.
  • Mocks unavailable pwnagotchi modules so the plugin can be loaded in isolation.
  • Checks plugin metadata and lifecycle attributes, while skipping structural checks when loading or class discovery fails.
  • Verifies required files such as requirements.txt and the executable script exist.
tests/test_pwnsorter.py
Adds a Python dependency manifest where needed.
  • Introduces requirements.txt for declaring runtime or test dependencies.
requirements.txt

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

@codacy-production

Copy link
Copy Markdown

Not up to standards ⛔

🔴 Issues 1 high

Alerts:
⚠ 1 issue (≤ 0 issues of at least minor severity)

Results:
1 new issue

Category Results
ErrorProne 1 high

View in Codacy

🟢 Metrics 36 complexity · 0 duplication

Metric Results
Complexity 36
Duplication 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

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