Skip to content

Latest commit

 

History

History
62 lines (38 loc) · 1.33 KB

CONTRIBUTING.md

File metadata and controls

62 lines (38 loc) · 1.33 KB

Contributing to DNSimple/Rust

Getting started

1. Clone the repository

Clone the repository and move into it:

git clone [email protected]:dnsimple/dnsimple-rust.git
cd dnsimple-rust

2. Build and test

Run the test suite to check everything works as expected.

Releasing

The following instructions uses $VERSION as a placeholder, where $VERSION is a MAJOR.MINOR.BUGFIX release such as 1.2.0.

  1. Set the version in Cargo.toml

    version = "0.1.0"

  2. Run the test suite and ensure all the tests pass.

  3. Finalize the ## main section in CHANGELOG.md assigning the version.

  4. Commit and push the changes

    git commit -a -m "Release $VERSION"
git push origin main

  5. Wait for CI to complete.

  6. Create a signed tag.

    git tag -a v$VERSION -s -m "Release $VERSION"
git push origin --tags

  7. The release GitHub action should take it from here and release the package to crates.io

Testing

To run the test suite:

cargo test

Tests

Submit unit tests for your changes. You can test your changes on your machine by running the test suite.

When you submit a PR, tests will also be run on the continuous integration environment via GitHub Actions.