Prepare for the v0.1.0 release#19
Conversation
|
The first release has to be published manually. I'll add a CI release workflow after that. |
There was a problem hiding this comment.
Pull request overview
This PR prepares the project for its initial v0.1.0 release by adding release documentation and updating the README with badges and contribution information.
- Adds release notes for the first release
- Enhances README with documentation badges and contribution guidelines
- Creates a comprehensive contributing guide with release procedures
- Adds a release notes template for future releases
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| RELEASE_NOTES.md | Adds initial release notes for v0.1.0 |
| README.md | Adds badges, expands documentation, and links to contributing guide |
| CONTRIBUTING.md | Provides release process documentation |
| .github/RELEASE_NOTES.template.md | Creates template for future release notes |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| the new release will be rejected by `crates.io`. | ||
|
|
||
| Along with this, update the `RELEASE_NOTES.md` file if it is not | ||
| complete, up to date, and remove template comments (`<!-- ... ->`) |
There was a problem hiding this comment.
Corrected malformed HTML comment closing syntax from ''.
| complete, up to date, and remove template comments (`<!-- ... ->`) | |
| complete, up to date, and remove template comments (`<!-- ... -->`) |
CONTRIBUTING.md
Outdated
| Release](https://github.com/frequenz-floss/frequenz-microgrid-component-graph-rs/releases), | ||
| and upload a new package to | ||
| [crates.io](https://crates.io/crates/frequenz-microgrid-component-graph) |
There was a problem hiding this comment.
The GitHub repository URL references 'frequenz-microgrid-component-graph-rs' but should reference 'frequenz-microgrid-rs' to match the actual project name.
| Release](https://github.com/frequenz-floss/frequenz-microgrid-component-graph-rs/releases), | |
| and upload a new package to | |
| [crates.io](https://crates.io/crates/frequenz-microgrid-component-graph) | |
| Release](https://github.com/frequenz-floss/frequenz-microgrid-rs/releases), | |
| and upload a new package to | |
| [crates.io](https://crates.io/crates/frequenz-microgrid-rs) |
CONTRIBUTING.md
Outdated
| a [GitHub | ||
| Release](https://github.com/frequenz-floss/frequenz-microgrid-component-graph-rs/releases), | ||
| and upload a new package to | ||
| [crates.io](https://crates.io/crates/frequenz-microgrid-component-graph) |
There was a problem hiding this comment.
The crates.io URL references 'frequenz-microgrid-component-graph' but should reference 'frequenz-microgrid-rs' to match the package name in Cargo.toml.
| [crates.io](https://crates.io/crates/frequenz-microgrid-component-graph) | |
| [crates.io](https://crates.io/crates/frequenz-microgrid-rs) |
|
Oops, AI is right |
Signed-off-by: Sahas Subramanian <sahas.subramanian@proton.me>
shsms
force-pushed
the
release-prep-0.1.0
branch
from
50a9d9e to
d6aa235
Compare
2 participants
No description provided.