Skip to content

chore: Update PR template for API changes - #4507

Merged
flub merged 1 commit into
mainfrom
flub/pr-template-api
Sep 4, 2026
Merged

flub merged 1 commit into
mainfrom
flub/pr-template-api

Conversation

@flub

@flub flub commented Sep 4, 2026

Copy link
Copy Markdown
Collaborator

Description

This aligns with a change started in noq:

  • Mention API changes rather than breaking changes.

  • Do not encourage to remote checkboxes. That leaves me guessing what
    the template should look like in each repo.

Breaking Changes

n/a

Notes & open questions

Equivalent noq pr: n0-computer/noq#796

Change checklist

  • Self-review.
  • Documentation updates following the style guide, if relevant.
  • Tests if relevant.
  • All breaking changes documented.
  • This PR was created by a human that thought critically about the
    proposed change and wrote an as clear and concise description as
    they could.
  • This PR isn't slop, and is carefully crafted to do have the
    intented effect.

This aligns with a change started in noq:

- Mention API changes rather than breaking changes.

- Do not encourage to remote checkboxes. That leaves me guessing what
  the template *should* look like in each repo.
@flub
flub requested a review from a team September 4, 2026 14:01
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown

Documentation for this PR has been generated and is available at: https://n0-computer.github.io/iroh/pr/4507/docs/iroh/

Last updated: 2026-09-04T14:01:56Z

@flub
flub enabled auto-merge September 4, 2026 14:02
@github-actions

github-actions Bot commented Sep 4, 2026

Copy link
Copy Markdown

Netsim report & logs for this PR have been generated and is available at: LOGS
This report will remain available for 3 days.

Last updated for commit: c2992a2

@n0bot n0bot Bot added this to iroh Sep 4, 2026
@github-project-automation github-project-automation Bot moved this to 🚑 Needs Triage in iroh Sep 4, 2026

@matheus23 matheus23 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd have like a super minor nit about being clearer about "API Changes" only being optional when there are no API changes, but 🤷‍♂️ I'm fine with it as-is, and it'd align with what we have in noq.

@flub
flub added this pull request to the merge queue Sep 4, 2026
Merged via the queue into main with commit 7a561e6 Sep 4, 2026
37 of 40 checks passed
@flub
flub deleted the flub/pr-template-api branch September 4, 2026 15:29
@github-project-automation github-project-automation Bot moved this from 🚑 Needs Triage to ✅ Done in iroh Sep 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants