Skip to content

fix: pull_request_template.md does not remind authors to link the Closes #issue_id per Guidelines #513

Description

Description

Every Stellar Wave issue's Guidelines section requires 'PR description must include: Closes #[issue_id]', but it's worth confirming .github/pull_request_template.md actually includes this reminder as a checklist item, rather than relying on each contributor to remember it from the issue body alone.

This is repository-level tooling, configuration, or process rather than application code, but that doesn't make it lower stakes: onboarding friction, unclear ownership, and process gaps are consistently what determines whether a project with this much surface area (two contract trees, two backend trees, two frontend apps, a static dashboard, and an active external contributor program) stays maintainable as it grows or slowly accumulates inconsistency that nobody has the full context to untangle.

Given that this repository is actively recruiting outside contributors through the Stellar Wave bounty program (this issue included), the quality of its repository-level scaffolding, from CONTRIBUTING.md to CODEOWNERS to its issue and PR templates, has a direct and measurable effect on how many contributors are able to land a change successfully on their first attempt versus giving up in the setup phase.

Requirements and context

  • Add a checklist item to the PR template reminding authors to include Closes #<issue>

Suggested execution

  1. Fork the repo and create a branch
    git checkout -b fix/pr-template-closes-reminder
    
  2. Implement changes
  • Update .github/pull_request_template.md
  1. Test and commit
  • Open a test PR and confirm the template renders the reminder

Example commit message

fix: add Closes #issue reminder checklist to PR template

Guidelines

  • Assignment required before starting
  • PR description must include: Closes #[issue_id]
  • Keep PR description professional and detailed

Activity

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

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave program

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions