Governance docs per CE PR 1226

Signed-off-by: Doug Davis <dug@microsoft.com>
This commit is contained in:
Doug Davis 2023-09-21 17:51:15 +00:00 committed by Jim Crossley
parent 9e10eaadf0
commit e19431fc06
3 changed files with 25 additions and 4 deletions

8
MAINTAINERS.md Normal file
View File

@ -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)

View File

@ -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)

10
RELEASING.md Normal file
View File

@ -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!