Add pre-commit hooks for markdown and yaml
Signed-off-by: ahuston-0 <aliceghuston@gmail.com>
This commit is contained in:
parent
dd5ea317b6
commit
2b800f4a4f
5
.mdl_style.rb
Normal file
5
.mdl_style.rb
Normal file
@ -0,0 +1,5 @@
|
||||
#!/usr/bin/env ruby
|
||||
|
||||
all
|
||||
rule 'MD007', :indent => 4
|
||||
rule 'MD013', :tables => false
|
10
README.md
10
README.md
@ -11,7 +11,7 @@ Mac (althought that hasn't been tested).
|
||||
Please see [our setup guide](./docs/setting-up.md) for more information on how
|
||||
to onboard a new user or system.
|
||||
|
||||
## Interested?
|
||||
## For Those Interested
|
||||
|
||||
Although we are not actively looking for new members to join in on this repo,
|
||||
we are not strictly opposed. Please reach out to @ahuston-0 or @RichieCahill
|
||||
@ -21,12 +21,12 @@ for further information.
|
||||
|
||||
- `keys/`: PGP public keys, for those who are using `SOPS` for secrets
|
||||
- `modules/`: Nix modules created by us for common services or overrides
|
||||
(fail2ban, hydra, certain boot params, etc.)
|
||||
(fail2ban, hydra, certain boot params, etc.)
|
||||
- `systems/`: config for common *server* components, as well as per-server configurations
|
||||
- `users/`: this directory has two major subdirectories, both are critical
|
||||
- `users/<user>`: includes configs for `home-manager`, `SOPS`, and `SSH` keys
|
||||
, for those who use them
|
||||
- `users/<user>/systems`: functions similarly to `systems/`, although for
|
||||
- `users/<user>`: includes configs for `home-manager`, `SOPS`, and `SSH` keys
|
||||
, for those who use them
|
||||
- `users/<user>/systems`: functions similarly to `systems/`, although for
|
||||
laptops, desktops, and even a Raspberry Pi now
|
||||
|
||||
## Contributing
|
||||
|
@ -91,13 +91,13 @@ rules.
|
||||
|
||||
- Critical issues may bypass the [quorum rules](#review-process), as long as the
|
||||
PR has been tested on at least one machine
|
||||
- Issues which bypass the quorum process must have a second reviewer tagged
|
||||
- All critical issues which bypass the approval process must have an RCA issue
|
||||
opened and the RCA logged into the `inc/` folder
|
||||
- The second reviewer has 2 weeks to retroactively review and approve the PR
|
||||
- If the retro does not happen in the given window, an issue shall be opened
|
||||
to either re-review the PR or to revert and replace the fix with a
|
||||
permanent solution
|
||||
- Issues which bypass the quorum process must have a second reviewer tagged
|
||||
- All critical issues which bypass the approval process must have an RCA issue
|
||||
opened and the RCA logged into the `inc/` folder
|
||||
- The second reviewer has 2 weeks to retroactively review and approve the PR
|
||||
- If the retro does not happen in the given window, an issue shall be opened
|
||||
to either re-review the PR or to revert and replace the fix with a
|
||||
permanent solution
|
||||
- Critical issues must be tagged to `Nix Flake Features` project, and must have
|
||||
a priority of `High` and an estimate tagged. Start and end date are not needed
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user