Merge remote-tracking branch 'upstream/main'

.github/ISSUE_TEMPLATE/bug.yml

@@ -25,18 +25,24 @@ body:
     attributes:
       label: How did you install the theme?
       options:
-        - GitHub Release
-        - AUR Package
-        - catppuccin/nix
-        - Nixpkgs
-        - Flatpak
-        - From source (Python script)
+        - From release (install.py)
+        - From release (manual installation)
+        - From source (build.py)
+        - Nix (nixpkgs / catppuccin/nix)
+        - AUR package
     validations:
       required: true
+  - type: checkboxes
+    attributes:
+      label: Are you running the latest release, and if not does the issue persist there?
+      description: "Our latest release can be found under the [GitHub releases](https://github.com/catppuccin/gtk/releases/latest)"
+      options:
+        - label: I am running on the latest release & the issue persists there
+          required: true
   - type: checkboxes
     attributes:
       label: If using GTK4, have you symlinked the "gtk-4.0" folder?
-      description: "The instructions for symlinking are described in the [README](https://github.com/catppuccin/gtk/tree/877e75568c9bb0d57c7ddda85b246fa17af45e57?tab=readme-ov-file#for-gtk-4-users)."
+      description: "The instructions for symlinking are described at the bottom of the [Manual Installation guide](https://github.com/catppuccin/gtk/tree/663f6c61f8cf1fcbbeb72110bf6b0a0214755245?tab=readme-ov-file#manual-installation)."
       options:
         - label: I have symlinked the `gtk-4.0` folder.
           required: false

CONTRIBUTING.md

@@ -19,6 +19,30 @@ so if you're changing them, they will need regenerated. Simply run `whiskers pal
 
 The process for building the theme is [documented in the README](./README.md#building).
 
+### Upstreaming procedure
+
+Now and again, Colloid will have bugs upstream that impacts our theme. With our patching system we can easily fix these problems,
+but we still want to contribute the fixes upstream to benefit all users & forks of Colloid.
+
+To avoid stalling unnecessarily, our procedure for the above is as follows:
+1) Open a PR to fix the issue, by adding a patch file to our theme, add `upstream:intended` 
+to signal these changes are to be sent to Colloid eventually.
+2) Merge the PR & close the issue in our theme pertaining to the issue, once reviewed and approved
+3) Open a PR in Colloid with the patch
+4) Open a new issue in our theme, with these details:
+    - The initial issue in our theme 
+    - The PR in Colloid that fixes the issue there
+    - The PR that fixed the issue in our theme
+
+    Add the `upstream:open` label
+5) Once the PR is merged in Colloid:
+    1) Test that the issue no longer persists, without our patch
+    2) Open a PR to remove the patch file in our theme, with these details:
+        - The tracking issue
+        - The commit that fixed the issue in Colloid
+    3) Close the tracking issue & merge the PR to remove the patch file
+
+
 ### Running test builds
 We support building and publishing test builds from PRs. When you open PRs, the CI will automatically build with your changes and push an artifact
 which bundles all of the produced themes.

README.md

@@ -83,6 +83,22 @@ You can set up our Nix module for GTK with the following config:
 
 Alternatively, if you are not using our Nix module, you can grab the theme from [nixpkgs/catppuccin-gtk](https://github.com/NixOS/nixpkgs/blob/master/pkgs/data/themes/catppuccin-gtk/default.nix)
 
+## Flatpak
+Flatpak by default restricts access to themes, to allow access, use the following: 
+```bash
+sudo flatpak override --filesystem=$HOME/.local/share/themes
+```
+
+After you've allowed access, set the theme, using the following:
+```bash
+# Change to suite your flavor / accent combination
+export FLAVOR="mocha"
+export ACCENT="mauve"
+
+# Set the theme
+sudo flatpak override --env=GTK_THEME="catppuccin-${FLAVOR}-${ACCENT}-standard+default"
+```
+
 ### Manual installation
 
 If your distro does not package our theme, and the installation script will not work for your use case, you can pull down releases and extract them yourself. You can find the [latest release on GitHub](https://github.com/catppuccin/gtk/releases/latest).