Skip to content

Add Pull Request template for SWoC '26 contributions #34

@Nitya-003

Description

@Nitya-003

Description

To ensure high-quality contributions and maintain the rigor of the SpectraGraph Intelligence Studio, we need to implement a standardized PULL_REQUEST_TEMPLATE.md.

With SWoC contributors working on modular transforms and UI components, a template is necessary to guide them in providing the right technical context, testing evidence, and ethical considerations.

Proposed Requirements

  • Create a .github/pull_request_template.md that includes the following sections:
  1. Linked Issue: A field to reference the issue being closed (e.g., Closes Bug : Fix Async/Sync Database Mismatch #10).
  2. Type of Change: Checkboxes for:
  • New Transform (OSINT Source)

  • Core Logic / API

  • UI / Dashboard Enhancement

  • Bug Fix

  • Transform Lifecycle Checklist: (Specific to SpectraGraph)

  1. Does the transform follow the BaseTransform subclass?
  2. Is there proper validation for input entities (IP, Domain, etc.)?
  3. Are Pydantic types used for normalization?
  • Testing Evidence: Mandatory section to paste logs from make dev or terminal output.
  • Visuals: A section for screenshots/GIFs (essential for UI updates).
  • Ethical Review: A checkbox confirming the contribution adheres to the Ethics & Safety Guidelines.

Why this is needed

Standardizing PRs will significantly reduce the time maintainers spend asking for missing information (like screenshots or API logic details). It also helps SWoC contributors ensure their code is "merge-ready" by following a clear checklist.

I would love to work on this issue and Submit a PR.
Labels: documentation, SWoC'26, good-first-issue, SWOC

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions