Skip to content

Tech: Outline for pull requests

Sean Leary edited this page Oct 25, 2026 · 8 revisions

For now, respond to all issues and PRs with something like this:

Thanks for raising this issue. Since it requests a behavior change, can you clarify whether this is causing a problem in someone's code, or if it is to bring the code up to the spec? FYI For context, please see the Readme section on Requirements for code changes

**What problem does this code solve?**

**Risks**

**Changes to the Existing Behavior**

**Changes to the API**

**Will this require a new release?**

**Should the documentation be updated?**

**Unit Tests**

**Refactoring**

**Review status**

Notes:

The "problem" may just be an enhancement, it does not have to be a bug fix.

In most cases a new release is not required.

After the code has been tested and reviewed, you can set the review status to something like, "ACCEPTED, Starting 3 day comment window", and then do the merge after 3 days. Minimum comment period is:

  • None for emergency commits
  • 3 days by default
  • 7 days for complex, risky, or behavior-changing commits

Clone this wiki locally