Skip to content

Standardize pull request guidance - #4

Merged
konojunya merged 2 commits into
mainfrom
jj/pull-request-template
Sep 8, 2026
Merged

konojunya merged 2 commits into
mainfrom
jj/pull-request-template

Conversation

@konojunya

@konojunya konojunya commented Sep 8, 2026

Copy link
Copy Markdown
Member

Background

Recent Stack pull requests consistently explain their context, implementation, validation, and review concerns, but each author currently has to recreate that structure manually. Repository-local guidance should make the expected format available to every contributor and coding agent.

Implementation Approach

  • Add .github/pull_request_template.md with the established four-section structure.
  • Add AGENTS.md to require English pull request titles and bodies and completion of every template section.
  • Exclude repository-only agent guidance from the distributed VSIX.

Testing Approach

  • git diff --check
  • npm ci
  • npm run package:check
  • Verified that the template contains all four required headings in the expected order.
  • Verified that AGENTS.md references the repository-local template and explicitly requires English pull request titles and bodies.
  • Verified that the packaged VSIX still matches the existing release allowlist and does not contain AGENTS.md.

Review Perspectives / Points of Concern

  • This changes contribution guidance only; runtime behavior, package code, releases, and repository settings are unchanged.
  • The template uses HTML comments so its prompts do not add noise to completed pull request descriptions.
  • The new AGENTS.md is repository guidance and is intentionally excluded from the end-user VSIX.

@konojunya
konojunya merged commit ee1a0f4 into main Sep 8, 2026
1 check passed
@konojunya
konojunya deleted the jj/pull-request-template branch September 8, 2026 15:02
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