mostr-zulip-bot/.github/pull_request_template.md
Tim Abbott 1cbaa43db5 github: Add a zulip/zulip style pull request template.
Hopefully, this will help improve the quality of new-contirbutor pull
requests to this project.
2024-11-25 17:54:02 -08:00

1.9 KiB

Fixes:

Screenshots and how this was tested:

Self-review checklist
  • Self-reviewed the changes for clarity and maintainability (variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

  • Explains differences from previous plans (e.g., issue description).
  • Highlights technical choices and bugs encountered.
  • Calls out remaining decisions and concerns.
  • Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

  • Each commit is a coherent idea.
  • Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

  • Visual appearance of the changes.
  • Responsiveness and internationalization.
  • Strings and tooltips.
  • End-to-end functionality of buttons, interactions and flows.
  • Corner cases, error conditions, and easily imagined bugs.