Skip to content

Commit

Permalink
docs: Document the orb- naming convention
Browse files Browse the repository at this point in the history
  • Loading branch information
TheButlah committed May 6, 2024
1 parent ce44c99 commit a3a7b45
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,11 @@ change things in a backwards-incompatible way at any time!
libc. PRs that use `libc` will be rejected if an equivalent safe function in
`nix` exists.
- PR names and the final squashed commit that gets merged, should start with an
area prefix, like `ir-camera:`. This helps disambigutate which part of the
area prefix, like `ir-camera:`. This helps disambiguate which part of the
monorepo changed at a glance.
- All first-party crates should start with the `orb-` prefix for the crate name,
and the crates' directories should omit this prefix. For example, the `attest`
dir contains the `orb-attest` crate.

## First time Setup

Expand Down

0 comments on commit a3a7b45

Please sign in to comment.