Keyboard shortcuts

Press โ† or โ†’ to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Code Guidelines

Please see the ODP Governance Statement for more details on the contribution process and how decisions are made within the ODP community.

Format, style, and linting

In general, all code contributions should include:

  • โœ… Unit Tests: Use cargo tarpaulin to ensure coverage.
  • ๐Ÿ“š Documentation: Update docs, READMEs, or rustdoc as needed.
  • ๐Ÿงน Linting and Formatting: Follow the project's coding style and use tools like cargo fmt and clippy.
  • ๐Ÿ‘€ Code Review: Be ready for review by maintainers.
  • ๐Ÿ” Feedback and Revisions: Collaborate to improve quality.

For more details on the contribution workflow for Patina-related contributions, please also see Patina Developer Documentation.