kenji/illogical-impulse
1
0
Fork 0
forked from Shinonome/dots-hyprland
Code Pull Requests Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Celestial.y
2025-10-10 22:46:28 +08:00
committed by GitHub
parent 38ac1723f6
commit b4b461d815
1 changed files with 17 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+17 -14
View File
@@ -1,14 +1,14 @@
# 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 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)
- We can accept features that we do not personally want, but in that case we will ask you to make it configurable/optionally loaded.
- 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`
- 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
@@ -17,30 +17,33 @@
# Setting up
Assumption: you have an Arch(-based) Linux system
The following instruction assumes that you have an Arch(-based) Linux system.
## Complete
_might not be necessary depending on what you change, but this is recommended_
_Might not be necessary depending on what you change, but this is recommended._
- [Install](https://end-4.github.io/dots-hyprland-wiki/en/ii-qs/01setup/) the dotfiles (if you don't wanna replace your stuff completely, do it on a new user)
- Make changes, copy changes to a fork, PR
- [Install](https://ii.clsty.link/en/ii-qs/01setup/) the dotfiles (if you don't wanna replace your stuff completely, do it on a new user).
- Make changes, copy changes to a fork, create PR.
## Partially working shell
_most stuff in the shell will work but not everything_
_Most stuff in the shell will work but not everything._
- Install Hyprland and the development version of Quickshell (`yay -S hyprland quickshell-git`)
- Copy `.config/quickshell` folder to your home directory
- Install Hyprland and the development version of Quickshell (`yay -S hyprland quickshell-git`).
- Copy `.config/quickshell` folder to your home directory.
## Extra setup for Quickshell
- Quickshell-specific LSP setup: Run `touch ~/.config/quickshell/ii/.qmlls.ini` for proper LSP support
- Hint for VSCode: Get the official "Qt Qml" extension, go to its settings and change custom exe path to `/usr/bin/qmlls6`
- Quickshell-specific LSP setup: Run `touch ~/.config/quickshell/ii/.qmlls.ini` for proper LSP support.
- Hint for VSCode: Get the official "Qt Qml" extension, go to its settings and change custom exe path to `/usr/bin/qmlls6`.
## Python
If your changes involves using python package or script, please use the virtual environment created by uv as described in `scriptdata/uv/README.md`.
# Running
- Launch Hyprland (not the "uwsm-managed" one)
- For the shell:
- Open `~/.config/quickshell/ii` in your code editor
- In a terminal run `pkill qs; qs -c ii` to start the shell in the terminal (for logs)
- Open `~/.config/quickshell/ii` in your code editor.
- In a terminal run `pkill qs; qs -c ii` to start the shell in the terminal (for logs).
- Make edits in the opened folder. Changes are reloaded live.