The Oxidizer Project

This repository contains a set of crates that help you build robust highly scalable services in Rust.

• Crates
• Repo Guidelines
• Releasing Crate Versions
• Trademarks

Crates

These are the crates built out of this repo:

• data_privacy - Mechanisms to classify, manipulate, and redact sensitive data.
• data_privacy_macros - Macros to generate data taxonomies.

Repo Guidelines

• Every PR submitted to this repo must follow the Conventional Commits specification.

• Every crate built in this repo should:

  • Have an entry in the Crates section above.
  • Have an entry in CHANGELOG.md.
  • Have a README.md file generated using cargo-rdme with a consistent set of badges (see crates/data_privacy/README.md as an example)
  • Have a CHANGELOG.md file generated using the release-crate.ps1 script.
  • Have a meaningful set of categories and keywords in their Cargo.toml file (see crates/data_privacy/Cargo.toml as an example). The oxidizer keyword should always be present.
  • Have a Rust-inspired logo.

The best way to get started with a new crate is to run scripts\add-crate.ps1 which will create a new folder and populate it to get you started on a new crate.

Releasing Crate Versions

Releasing new versions of crates to crates.io is handled by an internal Microsoft automation process. To release a new version of any crate, use the scripts\release-crate.ps1 script. For example:

scripts\release-crate.ps1 data_privacy

Once you run this script, the version of the crate is updated and the crate's CHANGELOG.md file is updated. You can then check in those changes to the repo and push to GitHub. Once these changes are committed, automation will kick in to tag the commit and push the crate to crates.io.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.