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

Commit f5cee9d

Browse files
author
James Munns
committed
Add a PR template
1 parent 93e3f4c commit f5cee9d

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

.github/pull_request_template.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
Thanks for submitting!
2+
3+
## Category
4+
5+
Is this PR a:
6+
7+
- [ ] New Not Yet Awesome item?
8+
- [ ] A WIP project addressing an open item?
9+
- [ ] Removing a Not Yet Awesome item?
10+
11+
## New Not Yet Awesome item checklist
12+
13+
- [ ] Is the request clearly stated, linking to relevant documentation, such as a whitepaper, protocol definition, datasheet, etc.?
14+
- [ ] Are the "Success Criteria" defined?
15+
- [ ] Is this request possible using today's Rust (not blocked by LLVM impl, rustc impl, etc.)?
16+
- [ ] Is this request broken into reasonable work packages, such as "Create HAL for XYZ chip", not "support all boards from ABC vendor"?
17+
18+
## WIP Project checklist
19+
20+
- [ ] Is there a link to the source project on GitHub/GitLab/etc?
21+
- [ ] Is the project open source?
22+
- [ ] Is it clear if contributions are welcome?
23+
- [ ] Is the project relevant to the TODO item it addresses?
24+
- [ ] Is the project more than just an empty repo or a placeholder (e.g. just a "hello world" `bin.rs`/`lib.rs`)?
25+
26+
## Remove an item checklist
27+
28+
- [ ] Has the project that fixes the item been mentioned in the PR?
29+
- [ ] Does the project address the original request fully?
30+
- [ ] Has the crate that addresses the request has been added to the [Awesome Embedded Rust] list?
31+
- [ ] Has the crate has been published on crates.io (or somewhere else where other people can consume it)?
32+
33+
[Awesome Embedded Rust]: https://github.com/rust-embedded/awesome-embedded-rust

0 commit comments

Comments
 (0)