Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Cargo feature docs requirement to graduation checklist #3693

Merged
merged 5 commits into from
Aug 8, 2023
Merged

Add Cargo feature docs requirement to graduation checklist #3693

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1c0e52d
Add Cargo feature docs requirement to graduation checklist
sffc Jul 17, 2023
f7875cc
Update graduation.md
sffc Jul 17, 2023
d4d0658
Fix formatting
sffc Jul 17, 2023
1dc49df
Update graduation.md
sffc Jul 22, 2023
e1f612f
Update graduation.md
sffc Jul 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/process/graduation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@ This document contains a checklist for the requirements to migrate a component f
- [ ] Use `dep:` for enabling dependencies
- [ ] The crate should be fully documented
- [ ] Every exported function should have docs coverage
- [ ] There should be a crate-level example that illustrates a common use case for the component
- [ ] All options and conditional code paths should have a corresponding docs test
- [ ] There should be a crate-level example that illustrates a common use case for the component with the heading `# Examples`
- [ ] All options and conditional code paths should have a corresponding docs test with the heading `# Examples`
- [ ] All functions that are conditional on a Cargo feature should say so (last line before `# Examples`): ```✨ *Enabled with the `alloc` Cargo feature.*```
- [ ] Compiled data constructors should say "with compiled data" in the first sentence and should have a Cargo feature alert following the above syntax.
- [ ] The data structs should fully follow ZeroVec style
- [ ] Deserialization should not have a "net violation" in the [verify-zero-copy](https://github.com/unicode-org/icu4x/blob/main/provider/datagen/tests/verify-zero-copy.rs) test
- [ ] Constructors should avoid allocating memory in the common case
Expand Down
Loading