Skip to content

Commit bbe0f06

Browse files
committed
Add notes on contributing to README.md
1 parent 5863f99 commit bbe0f06

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,22 @@ A collection of crates for use alongside [esp-hal], but which are maintained by
88

99
[esp-hal]: https://github.com/esp-rs/esp-hal/
1010

11+
## Contributing a Crate
12+
13+
If you have a crate which depends on `esp-hal` and provides some additional functionality, we encourage you to contribute it to this repository!
14+
15+
When opening a pull request to add a new crate, we ask that you please ensure the following criteria are met:
16+
17+
- The new crate follows the `esp-hal-*` naming convention
18+
- The new crate contains `CHANGELOG.md` and `README.md` files, following the formatting of other crates in this repository
19+
- The new crate is added to the CI workflow
20+
- The new crate has been added to `CODEOWNERS` along with your username
21+
- If you are unable or unwilling to take ownership of this crate for whatever reason, please state such in your pull request and we can try to find an owner for it
22+
23+
Upon approval of your pull request, you will be granted Maintainer privileges on the repository and be added as an owner on [crates.io], assuming you are commiting to be code owner for the added crate.
24+
25+
[crates.io]: https://crates.io
26+
1127
## License
1228

1329
Licensed under either of:

0 commit comments

Comments
 (0)