hyprspace/docs/content/Development/for-contributors.md
Max 76a3f73a42
Build and installation docs (#47)
* README: document basic build/setup steps

* document dev setup and how the config schema works

* set up for use with direnv

* mention direnv in the dev setup docs

* README: mention developer docs

* provide some contributor infos
2024-07-15 17:51:14 +00:00

781 B

For Contributors

This page contains some information you might find useful when contributing to Hyprspace.

Canonical Repository Location

Development canonically takes place at https://github.com/hyprspace/hyprspace. Feel free to open issues and PRs there.

Continuous Integration

Hyprspace uses Hercules CI to verify code functionality and quality. You can also run all the builds and checks locally by running:

$ nix flake check

Code Formatting

Hyprspace's codebase consists mainly of Go and Nix code. go fmt and nixfmt (RFC Style) are used respectively to format the code for those languages. Formatting is enforced via CI.

Formatters are available in the Development.