From 66e40128f8075da9d6f93093072ebe1f901a12b3 Mon Sep 17 00:00:00 2001 From: end-4 <97237370+end-4@users.noreply.github.com> Date: Mon, 6 Oct 2025 22:42:10 +0200 Subject: [PATCH] contributing: add some notes about code --- CONTRIBUTING.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7af06aaa0..0be4626d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,8 +1,19 @@ # Contributing +- Please, please, please, make multiple PRs if you have many features/fixes, and don't shove your personal changes along with the PR, including changed defaults - I can accept features I do not personally want, but in that case I will ask you to make it configurable/optionally loaded -- If you want to add new stuff, it's a good idea to ask me first to not waste your work -- Please make multiple PRs if you have many features/fixes +- If you want to start working on something big to contribute, it might be a good idea to ask first to not waste your effort (but if you've already done it for yourself, it doesn't hurt to submit) + +# Code details + +## Dynamic loading + +- If something's not always necessary, especially when guarded by a config option to enable/disable, put it in a `Loader`. One tip with `Loader`s is sometimes you will need to declare positioning properties (like `anchors`) in the `Loader`, not the `sourceComponent` + +## Practical concerns + +- Make sure what you add does not require significant resources for a minor purpose or harm usability just for the sake of looking nice. The dotfiles must remain practical for daily driving. +- If there is something really fancy and impractical anyway, add a config option for it and make sure it's disabled by default. # Setting up