Skip to content

Commit

Permalink
Merge pull request #61 from Mark-Simulacrum/target-review
Browse files Browse the repository at this point in the history
Add policy detailing review procedure for target-specific code
  • Loading branch information
dtolnay authored Jan 21, 2024
2 parents 3276406 + d77c259 commit 23d4ff6
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- [When to `#[inline]`](./policy/inline.md)
- [Doc alias policy](./policy/doc-alias.md)
- [Safety comments policy](./policy/safety-comments.md)
- [Reviewing target-specific code](./policy/target-code.md)

- [Tricky situations]()
- [Drop and `#[may_dangle]`](./tricky/may-dangle.md)
Expand Down
25 changes: 25 additions & 0 deletions src/policy/target-code.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Reviewing target-specific code

When reviewing target-specific code, depending on the [tier] of the target in
question, different level of scrutiny is expected from reviewers.

For tier 1 targets, the reviewer should perform a full review of the code.
Essentially treat the code as *not* platform specific.

For tier 2 and tier 3 targets, the reviewer should confirm that the code:

* Only affects 1 or more of such targets (i.e., is truly target-specific)
* Does not introduce new licensing hazards (e.g., license headers or similar)
* Is either proposed by a target maintainer[^1] or has pinged and received +1s
from at least one target maintainer. Where no maintainer is present, look for
whether the author is reputable and/or affiliated with the target in some way
(e.g., authored original code, works for a company maintaining the target, etc.).

Note that this review does *not* include checking for correctness or for code
quality. We lack the review bandwidth or expertise to perform detailed reviews
of tier 2 and tier 3 targets.

[^1]: Target maintainers are listed for most targets in the [platform support] documentation.

[tier]: https://doc.rust-lang.org/nightly/rustc/platform-support.html
[platform support]: https://doc.rust-lang.org/nightly/rustc/platform-support.html

0 comments on commit 23d4ff6

Please sign in to comment.