axeman/pub-solar-os
1
0
Fork 0
forked from pub-solar/os
Code Issues Pull requests Packages Projects Releases Wiki Activity
pub-solar-os/doc/CONTRIBUTING.md
Trevor Riles 804e972c57 Update docs and scripts to use main branch. 
When following the getting started guide commands were failing due to
the mater branch not existing. I went through and updated all
references in the docs and other scripts from master to main.
2021-10-09 11:19:52 -05:00

690 B
Raw Blame History

Pull Requests

TL;DR;

  • Target Branch: main
  • Merge Policy: bors is always right (→ bors try)
  • Docs: every changeset is expected to contain doc updates
  • Commit Msg: be a poet! Comprehensive and explanatory commit messages should cover the motivation and use case in an easily understandable manner even when read after a few months.
  • Test Driven Development: please default to test driven development where possible.

Within the Devshell (nix develop)

  • Hooks: please git commit within the devshell
  • Fail Early: please run from within the devshell on your local machine:
    • nix flake check