chore: Update PR template to mention API changes - #796
Merged
Merged
Conversation
The breaking changes section is too narrow really today. We need to be able to identify API additions and deprecations mostly. Breaking changes only comes back once we work towards 2.0.
Performance Comparison Report
|
|
Documentation for this PR has been generated and is available at: https://n0-computer.github.io/noq/pr/796/docs/noq/ Last updated: 2026-09-02T12:53:31Z |
7 tasks
rklaehn
approved these changes
Sep 2, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Sep 2, 2026
6 tasks
Stanley00
pushed a commit
to stanley-fork/iroh
that referenced
this pull request
Sep 4, 2026
## 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 - [x] Self-review. - [x] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. - [x] Tests if relevant. - [x] All breaking changes documented. - [x] 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. - [x] This PR isn't slop, and is carefully crafted to do have the intented effect.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The breaking changes section is too narrow really today. We need to be
able to identify API additions and deprecations mostly. Breaking
changes only comes back once we work towards 2.0.
Additionally stop encouraging folks to remove some checkboxes. I'd
rather have them un-ticked.
Breaking Changes
n/a
Notes & open questions
Change checklist
proposed change and wrote an as clear and concise description as
they could.
intented effect.
cargo makepasses locally.