From e19431fc06b3c395653817c4c09f0c2cf217aea9 Mon Sep 17 00:00:00 2001 From: Doug Davis Date: Thu, 21 Sep 2023 17:51:15 +0000 Subject: [PATCH] Governance docs per CE PR 1226 Signed-off-by: Doug Davis --- MAINTAINERS.md | 8 ++++++++ README.md | 11 +++++++---- RELEASING.md | 10 ++++++++++ 3 files changed, 25 insertions(+), 4 deletions(-) create mode 100644 MAINTAINERS.md create mode 100644 RELEASING.md diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 00000000..468c43ed --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,8 @@ +# Maintainers + +Current active maintainers of this SDK: + +- [Jim Crossley](https://github.com/jcrossley3) +- [Linus Basig](https://github.com/linuxbasic) +- [Francesco Guardiani](https://github.com/slinkydeveloper) +- [Fabrizio Lazzaretti](https://github.com/Lazzaretti) diff --git a/README.md b/README.md index 6d6346c2..6cba758b 100644 --- a/README.md +++ b/README.md @@ -67,10 +67,6 @@ Checkout the examples using our integrations to learn how to send and receive ev * [Warp Example](example-projects/warp-example) * [NATS Example](example-projects/nats-example) -## Development & Contributing - -If you're interested in contributing to sdk-rust, look at [Contributing documentation](CONTRIBUTING.md) - ## Community - There are bi-weekly calls immediately following the @@ -102,3 +98,10 @@ information. [Docs badge]: https://docs.rs/cloudevents-sdk/badge.svg [docs.rs]: https://docs.rs/cloudevents-sdk [feature flag]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section + +## Additional SDK Resources + +- [List of current active maintainers](MAINTAINERS.md) +- [How to contribute to the project](CONTRIBUTING.md) +- [SDK's License](LICENSE) +- [SDK's Release process](RELEASING.md) diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 00000000..afa32d95 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,10 @@ +# How to create a Release + +To create a new release, do the following: +- Bump the version in the README, lib.rs and cargo.toml +- Try to run `cargo test --all-features`, `cargo doc --all-features --lib` and + `cargo publish --dry-run` +- If none of the above commands fail, PR the changes and merge it +- Checkout `main` on your local machine and run `cargo publish` +- Once that is done, create the release in the Github UI (make sure it + creates the git tag as well) and that's it!