Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
44 lines (27 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

44 lines (27 loc) · 2.51 KB
Raw

Contributing to Hexeract

Hexeract is currently in alpha (v0.6.0): Outbox, Bus, Mediator and the durable Scheduler are shipped on crates.io, with Sagas and Request/Reply still ahead on the roadmap. The repository is public on nubster-opensources/hexeract and contributions are welcome.

Conventions

Hexeract follows the Nubster general coding standards documented in nubster-docs. In short:

  • Trunk-Based Development, feature branches feature/<issue>-<slug> from main, never commit directly on main.
  • Conventional Commits, all commit messages follow the type(scope): description format, enforced by cog verify in the commit-msg hook.
  • Rust style, workspace lints clippy::all and clippy::pedantic set to deny, MSRV pinned in rust-toolchain.toml and Cargo.toml.
  • No competitor mentions, the source code, commit messages, pull requests and documentation never name competing tools.
  • English on the public API, French on internal artifacts, rustdoc comments and public types are written in English; commit messages and issues are written in French; all documentation shipped in the repository is written in English.

Local setup

# Pin the Rust toolchain via rustup
rustup show

# Install local git hooks
lefthook install

# Run tests
cargo test --workspace --all-features

Discussion before code

Until v1.0, all design decisions go through a discussion/ thread on the repository before any pull request is opened. This includes the public traits, the transport abstraction, the outbox schema and the saga state machine.

Contributor License Agreement

Contributions to this project are governed by the Nubster Contributor License Agreement, hosted at github.com/nubster-opensources/cla.

On your first pull request, the CLA Assistant bot will automatically prompt you to sign the CLA. Once signed, your signature applies to all current and future contributions to any nubster-opensources project.

The CLA is a license grant (not a copyright assignment): you keep the copyright on your contributions and grant Nubster a broad license to use, sub-license, and re-license them.

License

By contributing, you agree that your contributions are dual-licensed under the MIT License and the Apache License, Version 2.0, at the user's option.

Copyright © Nubster.