Skip to content

Commit e19431f

Browse files
Doug Davisjcrossley3
Doug Davis
authored andcommitted
Governance docs per CE PR 1226
Signed-off-by: Doug Davis <[email protected]>
1 parent 9e10eaa commit e19431f

File tree

3 files changed

+25
-4
lines changed

3 files changed

+25
-4
lines changed

MAINTAINERS.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Maintainers
2+
3+
Current active maintainers of this SDK:
4+
5+
- [Jim Crossley](https://github.com/jcrossley3)
6+
- [Linus Basig](https://github.com/linuxbasic)
7+
- [Francesco Guardiani](https://github.com/slinkydeveloper)
8+
- [Fabrizio Lazzaretti](https://github.com/Lazzaretti)

README.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,6 @@ Checkout the examples using our integrations to learn how to send and receive ev
6767
* [Warp Example](example-projects/warp-example)
6868
* [NATS Example](example-projects/nats-example)
6969

70-
## Development & Contributing
71-
72-
If you're interested in contributing to sdk-rust, look at [Contributing documentation](CONTRIBUTING.md)
73-
7470
## Community
7571

7672
- There are bi-weekly calls immediately following the
@@ -102,3 +98,10 @@ information.
10298
[Docs badge]: https://docs.rs/cloudevents-sdk/badge.svg
10399
[docs.rs]: https://docs.rs/cloudevents-sdk
104100
[feature flag]: https://doc.rust-lang.org/cargo/reference/manifest.html#the-features-section
101+
102+
## Additional SDK Resources
103+
104+
- [List of current active maintainers](MAINTAINERS.md)
105+
- [How to contribute to the project](CONTRIBUTING.md)
106+
- [SDK's License](LICENSE)
107+
- [SDK's Release process](RELEASING.md)

RELEASING.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# How to create a Release
2+
3+
To create a new release, do the following:
4+
- Bump the version in the README, lib.rs and cargo.toml
5+
- Try to run `cargo test --all-features`, `cargo doc --all-features --lib` and
6+
`cargo publish --dry-run`
7+
- If none of the above commands fail, PR the changes and merge it
8+
- Checkout `main` on your local machine and run `cargo publish`
9+
- Once that is done, create the release in the Github UI (make sure it
10+
creates the git tag as well) and that's it!

0 commit comments

Comments
 (0)