Skip to content
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

feat(*): Adds additional documentation to the top level #4

Merged
merged 1 commit into from
May 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Code of Conduct

This project adheres to the [Bytecode Alliance Code of
Conduct](https://github.com/bytecodealliance/governance/blob/main/CODE_OF_CONDUCT.md). Any
violations of the code of conduct should be reported to [email protected]
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Contributing to Rust OCI Wasm

Thanks for your interest in contributing to Rust OCI Wasm! Our process for contribution is fairly
straightforward as this is a small project. Bug fixes and new features must be submitted using a
pull request. For new features, it is also recommended to first open an issue to discuss the feature
before submitting a pull request.

## Working with the code

The only required tooling outside of a standard development tool chain is

- A valid [Rust installation](https://www.rust-lang.org/tools/install)
- Docker installed (for running integration tests)

As this is a wrapper around another crate, most of our tests are done via integration tests, which
can be found in the `tests/` directory. Please note that these tests are run as part of the CI
pipeline, so they must pass before a pull request can be merged.

## Releasing the project

Releases are done by project maintainers as deemed necessary. Releases are entirely automated and
can be triggered by tagging the desired commit with a tag of the form `vX.Y.Z`. This will
automatically trigger the release process, which pushes the crate to crates.io.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,5 @@ This repo contains a Rust crate implementing the [OCI Wasm
Specification](https://tag-runtime.cncf.io/wgs/wasm/deliverables/wasm-oci-artifact/). It is a thin
wrapper around the [oci-distribution](https://crates.io/crates/oci-distribution) crate with the
specific config types needed for the OCI Wasm specification.

**A [Bytecode Alliance](https://bytecodealliance.org/) hosted project**
13 changes: 13 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Security

## Supply chain security

This project uses GitHub's dependabot to file automatic issues for dependency security updates.
Maintainers will review and apply these updates as soon as possible.

## Reporting a security vulnerability

If you believe you have found a security vulnerability in this project, please report it using the
"Security" tab at the top of the repo. This project uses the GitHub security features to allow for
confidential vulnerability reporting and fixes. Any security bugs will receive a CVE number and be
tracked through the GitHub security feature.