You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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]”>
Copy file name to clipboardExpand all lines: .github/pull_request_template.md
+8-1Lines changed: 8 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -11,8 +11,15 @@
11
11
<!-- Any notes, remarks or open questions you have to make about the PR. -->
12
12
13
13
## Change checklist
14
-
14
+
<!-- Remove any that are not relevant. -->
15
15
-[ ] Self-review.
16
16
-[ ] 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.
17
17
-[ ] Tests if relevant.
18
18
-[ ] 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:
0 commit comments