Skip to content

Add contributing guidelines check reminder in pull request template #447

Description

@Cjay-Cyber-2

Description — what to implement and the why/impact.

Clear pull request instructions help contributors follow project conventions, such as linking issues, ensuring Zod validation, and maintaining TypeScript strictness. Adding or refining a pull request template standardizes PR submissions.

Context & Requirements — background, constraints, design references, edge cases;

grounded in the actual repo (real files, stack, conventions).

  • GitHub templates reside in .github/pull_request_template.md (or .github/ISSUE_TEMPLATE/).
  • Include checkboxes for running tests (npm test), building (npm run build), and referencing the closed issue.

Acceptance Criteria — a checklist ("- [ ] ...") of specific, testable conditions that define "done".

  • Create or update .github/pull_request_template.md.
  • Include reminders for tests, linting, and issue linking (Closes #...).

Implementation Guidance — likely files/modules to touch (use real paths from the repo context) and a suggested approach, without over-prescribing.

  • Likely files: .github/pull_request_template.md

Testing & Validation — how the contributor should prove it works (tests to add/run, manual checks, screenshots for UI).

  • Verify file existence and markdown formatting.

Submission Guidelines — must open a PR that includes "Closes #"; assignment is required before starting; follow the repo's existing style and conventions.


Wave complexity: Trivial

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Stellar WaveIssues in the Stellar wave programcomplexity: trivialDrips Wave — small, well-bounded taskdocsdrips-waveTracked in a Drips Wave program

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions