Prepare for publishing

This commit is contained in:
Mihai Dinculescu
2022-10-20 18:34:52 +01:00
parent aac950b48f
commit ea9236f3f6
16 changed files with 706 additions and 28 deletions

30
CONTRIBUTING.md Normal file
View File

@@ -0,0 +1,30 @@
# Contributing
Contributions are welcome and encouraged! See [/issues][issues] for ideas, or suggest your own!
If you're thinking to create a PR with large feature/change, please first discuss it in an issue.
## Releases
- Update version in `simconnect-sdk-derive/Cargo.toml`
- Update version in `simconnect-sdk/Cargo.toml` (crate + `simconnect-sdk-derive`)
- Update CHANGELOG.md
- Commit
- Add tag
```bash
git tag -a vX.X.X
```
- Push
```bash
git push --follow-tags
```
- Release\
Create a [new release][releases]. \
The `publish.yml` GitHub Action will pick it up and do the actual release to [crates.io][crates_io].
[issues]: https://github.com/mihai-dinculescu/simconnect-sdk/issues
[releases]: https://github.com/mihai-dinculescu/simconnect-sdk/releases
[crates_io]: https://crates.io