Skip to content

CONTRIB.md

Latest commit

 

History

History
33 lines (26 loc) · 968 Bytes

CONTRIB.md

File metadata and controls

33 lines (26 loc) · 968 Bytes

Contribution Guide

(rn just dump notes here in an unorganized manner)

Development Environment

We assume the following executables are on the developer machine (along with a Rust toolchain):

  • jj (only compatible VCS)
  • just
  • cargo-nextest
  • cargo-insta
  • git-cliff
  • nu (for any not-simple automation)
  • rg (for any necessary text search)

All project automation is only allowed to be written using the above executables in addition to the default UNIX utilities (cut, sed, tail, touch, rm, and friends)

Commit Trailers

We expect each commit to at least have a "Signed-Off-By" commit trailer for identifying who created a specific change, and anyone who modified that change.

Because this poject require the VCS used to be Jujitsu:

  1. Run jj config edit --repo.
  2. Add the following fragment to the config: 
     [templates]
 commit_trailers = '''
 format_signed_off_by_trailer(self)
 '''
3. Save, and you are ready!