Skip to content
This repository was archived by the owner on Jul 1, 2025. It is now read-only.

Commit d417421

Browse files
bors[bot]jamesmunns
andcommitted
Merge #7
7: Clarify that the template should be used r=andre-richter a=jamesmunns Thanks for submitting! ## Category Is this PR a: - [ ] New Not Yet Awesome item? - [ ] A WIP project addressing an open item? - [ ] Removing a Not Yet Awesome item? - [x] Meta request Co-authored-by: James Munns <james@onevariable.com>
2 parents 1715cb4 + f43f2ea commit d417421

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,17 @@ Anyone can submit an item that they think is not yet awesome to the list. To do
1414

1515
In order to help people make this thing awesome, your item should meet all of the following criteria:
1616

17-
1. You request is clearly stated, linking to relevant documentation, such as a whitepaper, protocol definition, datasheet, etc.
17+
1. Your request is using the [template] provided in the README
18+
2. Your request is clearly stated, linking to relevant documentation, such as a whitepaper, protocol definition, datasheet, etc.
1819
* This lets someone know how to implement this request, and make Embedded Rust more awesome.
19-
2. "Success Criteria" for your request are defined, such as "Add PWM support to the iMXRT1050 HAL"
20+
3. "Success Criteria" for your request are defined, such as "Add PWM support to the iMXRT1050 HAL"
2021
* This lets the reviewer know when the work is done, so they can remove this item from the list
21-
3. Possible using today's Rust (not blocked by LLVM impl, rustc impl, etc.)
22+
4. Possible using today's Rust (not blocked by LLVM impl, rustc impl, etc.)
2223
* For now, we can't accept anything in this list that is not possible with today's (preferrably stable) version of Rust. This keeps items from staying on the list for too long.
23-
4. Your request should be broken into reasonable work packages, such as "Create HAL for XYZ chip", not "support all boards from ABC vendor"
24+
5. Your request should be broken into reasonable work packages, such as "Create HAL for XYZ chip", not "support all boards from ABC vendor"
2425
* This also keeps items from staying on the list for too long
26+
27+
[template]: https://github.com/rust-embedded/not-yet-awesome-embedded-rust#not-yet-awesome-item-template
2528

2629
Once you've submitted a PR by editing the README, someone from the WG will review your suggestion to make sure that it meets the criteria above. They'll help you fix any issues with your request. Once the review checklist is complete, and any fixes are made, the item will be added to the list!
2730

0 commit comments

Comments
 (0)