Add CONTRIBUTING.md #400
Add CONTRIBUTING.md #400
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| We welcome new shims, though you can also host them in your own repositories as well and use the `coantainerd-shim-wasm` crate. We recognize that the project is moving fast to having them in this repository can reduce the need for changes as well for discoverability. | ||
|
|
||
| Please open an issue before submitting a PR for discussion to make sure it is a good fit. As a general rule, we want shims to be adopting WASI spec. Since we are not experts in every runtime we also need a commitment from the runtime owners to contribute to maintenance of the shim. |
There was a problem hiding this comment.
This is related to #338
A good way to make sure the new shim is compilant is to run a suit of WASI tests that we provide (not right now, but may in the future)
There was a problem hiding this comment.
cool I will mention we are looking at this and may become a hard requirement in the future.
There was a problem hiding this comment.
updated, please check wording
CONTRIBUTING.md
Outdated
|
|
||
| ## Removing Shims | ||
|
|
||
| If a shim in not maintained for 6 months it will be subject to removal. Before removal: |
There was a problem hiding this comment.
Is ambiguous to me if this is saying the "shim" itself is not maintained, or the "runtime" underneath the shim is not maintainer for 6 months.
There was a problem hiding this comment.
I am not sure how to define this. Open to wording and we can discuss more in the meeting next week.
I don't think it is just the runtime its self (but that is a good thing to call out here). But also want to avoid a situation if there is a bug in the runtime that surfaces in our test suite or need changes to runtime to support a feature but no one is around to help resolve quickly even if the runtime is actively maintained.
There was a problem hiding this comment.
I've taken another shot at this
yes, makes sense. I will split them up |
Signed-off-by: James Sturtevant <[email protected]>
jsturtevant
force-pushed
the
add-contributing-doc
branch
from
f83b18e to
3eb7d36
Compare
|
Moved the adding/removing details to #408 |
|
Could you please take another look before I merge this in? @jprendes |
|
Going to merge this in. |
Adding a contributing doc which includes guidance for adding and removing new shims.