Skip to main content

Contributing to dfxvm

Thank you for your interest in contributing to dfxvm! By participating in this project, you agree to abide by our Code of Conduct.

CLA​

All code contributions are subject to our Contributor License Agreement (CLA). When you open your first PR, the CLA bot will prompt you to agree to the CLA before the PR can be reviewed and merged.

Documentation​

Every change to the command-line interface must contain documentation. We use clap, so Rustdoc comments turn into CLI documentation. Additionally, this in-code documentation must be mirrored by a corresponding change in docs/cli-reference. Finally, any feature or notable bugfix should be mentioned in CHANGELOG.md, under the ## Unreleased header.

Release Process​

Prerequisites to make a release:

cargo install cargo-release
cargo install cargo-dist

To make a release, follow these steps:

  1. Run the Prepare Release workflow.
  2. Obtain approval and merge the PR that the workflow generated.
  3. Run the following locally:
git checkout main
git pull
cargo dist plan
cargo release --execute