RGBCube/agenix
1
Fork 0
mirror of https://github.com/RGBCube/agenix synced 2025-07-29 09:47:44 +00:00
Code Issues Activity Actions

doc: add new doc website

Browse source 
* 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
This commit is contained in:
Ryan Mulligan 2023-02-26 14:17:37 -08:00
parent 4828951d9d
commit 657789137c
22 changed files with 602 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

28
doc/contributing.md Normal file
View file

@ -0,0 +1,28 @@
# Contributing {#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
```ShellSession
nix flake check
```
You can run the integration tests in interactive mode like this:
```ShellSession
nix run .#checks.x86_64-linux.integration.driverInteractive
```
After it starts, enter `run_tests()` to run the tests.