1
1
mirror of https://github.com/divnix/digga.git synced 2024-11-26 12:03:03 +03:00
digga/doc/CONTRIBUTING.md
David Arnold fee8829dd7 docs: add general docs (w/o library reference)
library reference expected to come as soon as flake-utils-plus has
the corresponding implementation.
2022-02-23 15:23:14 -08:00

729 B

TL;DR;

  • Target Branch: main
  • Merge Policy: bors is alwyas 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 you can make use of the ./examples & ./e2e and wire test up in the devshell.

Within the Devshell (nix develop)

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