Skip to content

Commit 31efead

Browse files
ramfox“ramfox”
and
“ramfox”
authored
chore: add additional todos in the "change checklist" (#3180)
## Description In order to be better prepared for releases, we are trying to "front load" more work on understanding the effects of breaking changes in our downstream dependencies. Part of this is to remind folks to take a look at the downstream dependencies when they make a breaking change, and file an issue (or they have capacity), open a PR on how to deal with those breaking changes in that dependency. The PR template looks like this now: ## Description <!-- A summary of what this pull request achieves and a rough list of changes. --> ## Breaking Changes <!-- Optional, if there are any breaking changes document them, including how to migrate older code. --> ## Notes & open questions <!-- Any notes, remarks or open questions you have to make about the PR. --> ## Change checklist - [ ] Self-review. - [ ] 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. - [ ] Tests if relevant. - [ ] All breaking changes documented. - [ ] List all breaking changes in the above "Breaking Changes" section. - [ ] Open an issue or PR on any number0 repos that are affected by this breaking change. Give guidance on how the updates should be handled or do the actual updates themselves. The major ones are: - [ ] `quic-rpc` - [ ] `iroh-gossip` - [ ] `iroh-blobs` - [ ] `dumbpipe` - [ ] `sendme` --------- Co-authored-by: “ramfox” <“[email protected]”>
1 parent 695f7c1 commit 31efead

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

.github/pull_request_template.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,15 @@
1111
<!-- Any notes, remarks or open questions you have to make about the PR. -->
1212

1313
## Change checklist
14-
14+
<!-- Remove any that are not relevant. -->
1515
- [ ] Self-review.
1616
- [ ] 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.
1717
- [ ] Tests if relevant.
1818
- [ ] All breaking changes documented.
19+
- [ ] List all breaking changes in the above "Breaking Changes" section.
20+
- [ ] Open an issue or PR on any number0 repos that are affected by this breaking change. Give guidance on how the updates should be handled or do the actual updates themselves. The major ones are:
21+
- [ ] [`quic-rpc`](https://github.com/n0-computer/quic-rpc)
22+
- [ ] [`iroh-gossip`](https://github.com/n0-computer/iroh-gossip)
23+
- [ ] [`iroh-blobs`](https://github.com/n0-computer/iroh-blobs)
24+
- [ ] [`dumbpipe`](https://github.com/n0-computer/dumbpipe)
25+
- [ ] [`sendme`](https://github.com/n0-computer/sendme)

0 commit comments

Comments
 (0)