From 2cd76f916a13e66f1fdf06dd7bf5dff6be64de0b Mon Sep 17 00:00:00 2001 From: Rory& Date: Fri, 7 Nov 2025 22:36:50 +0100 Subject: WIP: nix CI --- CONTRIBUTING.MD | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CONTRIBUTING.MD (limited to 'CONTRIBUTING.MD') diff --git a/CONTRIBUTING.MD b/CONTRIBUTING.MD new file mode 100644 index 0000000..8c305b7 --- /dev/null +++ b/CONTRIBUTING.MD @@ -0,0 +1,30 @@ +# Contributing + +Any contribution is welcome, even if it's just documentation or recommended git practices! We're not too strict on code style, but we do have a few guidelines: +- Use spaces, not tabs +- Use 4 spaces for indentation +- Use the C# naming convention for variables, methods, etc. +- Wrap lines at 160 characters, though this value can be changed if it's too lean or strict +- Use the `#region` and `#endregion` directives to group code if you're adding utility functions + +```sh +# Prepare patch set +mkdir patches +git format-patch --output-directory "./patches" @{u}.. + +# Send patches +... +``` +You can send the patches to [@emma:rory.gay](https://matrix.to/#/@emma:rory.gay) or in the [Rory&::LibMatrix room](https://matrix.to/#/#libmatrix:rory.gay). + +### Developer utility commands + +Error reporting upon file save (may not work): +```sh +inotifywait -rmqe CLOSE_WRITE --include '.*\.cs$' . | while read l; do clear; dotnet build --property WarningLevel=0; done +``` + +Hot rebuild on file save: +```sh +dotnet watch run --no-hot-reload --property WarningLevel=0 +``` -- cgit 1.5.1