Skip to content

fix: refine PR template with project-specific commands, env vars, and checklist#173

Open
Xuccessor wants to merge 1 commit into
Quantarq:mainfrom
Xuccessor:fix/issue-71-pr-template-improvements
Open

fix: refine PR template with project-specific commands, env vars, and checklist#173
Xuccessor wants to merge 1 commit into
Quantarq:mainfrom
Xuccessor:fix/issue-71-pr-template-improvements

Conversation

@Xuccessor

Copy link
Copy Markdown

Summary

The existing .github/pull_request_template.md lacked project-specific context (commands, env vars). This PR refines the template so contributors run the project's make lint / make test flow and surface any environment-variable changes.

Changes

  • Added a Commands Run hint in Testing Done that references make ci and poetry run pytest web_app/tests -v --tb=short for backend changes.
  • Added an Environment Variables section with a .env.example hint so contributors update deployment docs alongside code.
  • Tightened the checklist (make lint, make test, CI green, env vars, issue link).
  • Removed the bureaucratic "Rollback Plan" section — keeps the template lean.

Testing

  • Manually rendered the markdown to confirm it stays readable and scales for typical PR sizes.
  • Cross-checked against Makefile, quantara/pyproject.toml, and .github/workflows/ci.yml to make sure the referenced commands actually exist.

Closes #71

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.

docs: Add PR template to .github/

1 participant