From e4fe282ffd41be2f4f9c8a99760185f3857032d1 Mon Sep 17 00:00:00 2001 From: voidarc Date: Sun, 16 Aug 2026 12:13:55 +0100 Subject: [PATCH] added a tldr to the CONTRIBUTING.md guidelines --- CONTRIBUTING.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5b75a9..83aceae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,33 @@ # CONTRIBUTING +## Tldr + +**Do's** + +- Be concise +- Follow the [Formatting Rules](#formatting-rules) to the best of your ability +- Segment larger changes into managable, reviewable commits +- Leave a trail of your development so I can tell you put some effort in (doesnt really + apply to smaller commits) +- Write your own code +- Leave some way of crediting your work +- Disclose the capacity in which you used AI. Most of the time, anything more than making + examples or helping you understand the codebase will be disallowed. As little AI code + should make it to production as possible + +**Dont's** + +- Report upstream issues to me (ie an issue with the app itself, not my config) +- Make major structural changes +- Submit chore commits such as updating the flake, I can do that myself +- Add new hosts for no reason, make your own flake and import the modules you want for + your host +- Majorly change existing hosts for your own preference +- Ask AI to fix your issues and expect me to merge changes +- Delete existing modules. Executive decisions like that will be made at my disgression, + and will be done as non-destructively as possible, such as moving those modules to a + "deprecated" branch in the future. + ## General format All emails regarding this repo (or another) should have a subject prepended with the