-
Notifications
You must be signed in to change notification settings - Fork 29
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs/setup_new_repo: add some staging guidelines #153
base: main
Are you sure you want to change the base?
Conversation
We have introduced a staging area in vhost-device to facilitate the development of pre-production code alongside the wider project. Lets formalise the approach with some guidelines for how staging areas should operate in rust-vmm. Signed-off-by: Alex Bennée <[email protected]>
referencing #133 (comment): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
I just wonder if it makes sense to add links to vhost-device as an example to follow (even for CI part using custom-pipelines)
Good point! I would be in favor, but maybe with restrictions, for example we could allow only |
I guess there is more of an argument for libraries (we explicitly said no for binaries). However what does it gain? It's not like its hard to import a crate from a git tree. |
Yep. I think I agree. But I think this probably rules this out as a mechanism for vhost-user-frontend. There we probably want a release so that cloud-hypervisor can switch over. |
Also sounds reasonable to me. I got no strong opinion here. |
Does cloud-hypervisor want to switch over given we are going to immediately start making changes and updates? I would have thought they could track via git trees if they are interested in testing where the changes go and then just switch when we get to production state? If we publish an initial release they will still have the pain if there are API changes between 0.1 and 0.2. |
Let's discuss that on the other ticket :) |
We have introduced a staging area in vhost-device to facilitate the development of pre-production code alongside the wider project. Lets formalise the approach with some guidelines for how staging areas should operate in rust-vmm.
Requirements
Before submitting your PR, please make sure you addressed the following
requirements:
git commit -s
), and the commitmessage has max 60 characters for the summary and max 75 characters for each
description line.
test.
Release" section of CHANGELOG.md (if no such section exists, please create one).
unsafe
code is properly documented.