Skip to content

Commit d5c278e

Browse files
authored
Elaborate on informational="unsound" (#1322)
* Elaborate on `informational="unsound"` * wodring
1 parent bd30502 commit d5c278e

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

MAINTAINERS_GUIDE.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,9 @@ You can usually make changes directly to the sumbitter's branch. It's a great wa
1313
If no upstream issue has been filed, ask the reporter to file one first.
1414

1515
## Check if there are any fixed versions
16-
We don't want to carry a non-actionable advisory if a fix is forthcoming. It's alright to delay by a day or two and then publish it once the fix ships.
16+
We don't want to carry a non-actionable advisory if a fix is forthcoming. It's alright to delay by a day or two and then publish it once the fix ships. If a fix has been applied in git but not released to crates.io, ask the upstream for a new point release.
1717

18-
If a fix has been applied in git but not released to crates.io, ask the upstream for a new point release.
19-
20-
If the upstream is unresponsive or is not interested in fixing the issue, we can carry the advisory anyway, but this can be a delicate matter. See [here](https://github.com/rustsec/advisory-db/issues/1092) for guidance, and feel free to consult the [Rust Moderation team](https://www.rust-lang.org/governance/teams/moderation) in case of doubt.
18+
If the upstream is unresponsive or is not interested in fixing the issue, we can carry the advisory anyway, but this can be a delicate matter. See [here](https://github.com/rustsec/advisory-db/issues/1092) for guidance, and feel free to consult the [Rust Moderation team](https://www.rust-lang.org/governance/teams/moderation) in case of doubt. If the upstream project disputes the existence of the issue, and it doesn't have a high severity, `informational = "unsound"` should be used; then `cargo audit` will report it as a warning rather than a hard error.
2119

2220
## Make sure the advisory text is clear and actionable
2321
If you don't understand what's going on, most users won't either. Ask the submitter specific questions to clarify the advisory text, if needed.
@@ -27,7 +25,7 @@ Avoid editing the text directly without clearing it with the submitter first; us
2725
## Check that the metadata is correct
2826
The date should be set to the original disclosure of the issue, not the date of the pull request.
2927

30-
`informational = "unsound"` is used for [soundness issues](https://rust-lang.github.io/unsafe-code-guidelines/glossary.html#soundness-of-code--of-a-library) that can only be triggered by a programmer (as opposed to e.g. a malicious input), and/or require very contrived code to trigger.
28+
`informational = "unsound"` is used for [soundness issues](https://rust-lang.github.io/unsafe-code-guidelines/glossary.html#soundness-of-code--of-a-library) that can only be triggered by a programmer (as opposed to e.g. a malicious input), and/or require very contrived code to trigger. They will be surfaced as warnings instead of hard errors by `cargo audit`.
3129

3230
`informational = "unmaintained"` has a [policy](https://github.com/rustsec/advisory-db/blob/main/HOWTO_UNMAINTAINED.md) associated with it; make sure it is followed. If any items are missing, advise the submitter how to proceed.
3331

0 commit comments

Comments
 (0)