Skip to content

Latest commit

 

History

History
16 lines (14 loc) · 1.32 KB

CONTRIBUTING.md

File metadata and controls

16 lines (14 loc) · 1.32 KB

Contributor Guidelines

  • Any STAM library implementation should always be in sync with the STAM specification, read that first.
    • Make sure you're familiar with the model as explained in the specification
    • Propose new ideas to the specification first (as extensions)
    • Specifications should leave enough freedom to the implementations for details
  • Formatting: Indentation style: 4 spaces, unix newlines, run a rust formatter (rustfmt)
  • Avoid merge commits and use rebase by default for merges, set git config pull.rebase true
  • STAM extensions may be implemented in the this library but need to be implemented as features that can be enabled/disabled. This allows users to compile a lighter version if certain extensions are not needed.
  • We follow the Rust API guidelines as much as possible
  • Recommended reading for Rust