contributing: add some notes about code

This commit is contained in:
end-4
2025-10-06 22:42:10 +02:00
committed by GitHub
parent 79ec382b7f
commit 66e40128f8
+13 -2
View File
@@ -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