summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-08-16 13:44:30 +0200
committerBenedikt Peetz <benedikt.peetz@b-peetz.de>2024-08-16 13:48:36 +0200
commit6e0363a9fb8c425d6a18b544801eabe8bc0f8ebb (patch)
tree64fb6ad4dfb6fe0df215833f03fff2c2debf056f
parentfix(README): Fix type in link to `git.vhack.eu` (diff)
downloadnixos-server-readme.tar.gz
nixos-server-readme.zip
docs(README): Add initial README readme
-rw-r--r--README.md15
1 files changed, 13 insertions, 2 deletions
diff --git a/README.md b/README.md
index 044a2c9..a1a0e11 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,15 @@
 # Vhack.eu server infrastructure
 
-Beware that this repository is only a mirror. The development happens on our
-self-hosted [cgit](https://git.vhack.eu/vhack.eu/nixos-server) instance.
+This repository includes the all configurations for all services at vhack.eu.
+
+## Contributing
+### Issue reporting
+Please send issue reports via mail to [admin@vhack.eu](mailto://admin@vhack.eu). Beware
+that we use [git-bug](https://github.com/git-bug/git-bug) for issue tracking, so you can
+clone this repository and get a list of open issues with `git bug ls`.
+We plan to improve this issue reporting system in the future.
+
+### Patches
+Please send your patches for now to [admin@vhack.eu](mailto://admin@vhack.eu) (with `git
+format-patch` and `git send-email`). We're hoping to set up a mailing list the future to
+improve this process.