mynix/agenix
1
0
Fork 0
mirror of https://github.com/ryantm/agenix.git synced 2024-12-23 08:08:29 +03:00
Code Issues Projects Releases Packages Wiki Activity
agenix/doc/contributing.md
Ryan Mulligan 657789137c doc: add new doc website 
* use mmdoc
* add github pages action to auto publish
* do not edit README for now, will follow up with a commit directs
people to the doc site
2023-03-04 10:34:29 -08:00

758 B
Raw Blame History

Contributing

  • The main branch is protected against direct pushes
  • All changes must go through GitHub PR review and get at least one approval
  • PR titles and commit messages should be prefixed with at least one of these categories:
    • contrib - things that make the project development better
    • doc - documentation
    • feature - new features
    • fix - bug fixes
  • Please update or make integration tests for new features
  • Use nix fmt to format nix code

Tests

You can run the tests with

nix flake check

You can run the integration tests in interactive mode like this:

nix run .#checks.x86_64-linux.integration.driverInteractive

After it starts, enter run_tests() to run the tests.