2.5 KiB
🫶 Support
Where to get help in case things don't work
Welcome to Catppuccin! We have many ports across the organisation contributed and maintained by people all over the world. However, issues and bug reports are never-ending due to how many we have!
Ultimately, Catppuccin relies on open source contributions from the community to keep ports healthy and up-to-date. You may find that certain repositories contain outdated documentation, long-standing issues or stale pull requests. It is always appreciated if you are able to help debug an issue, provide extra context, contribute to another pull request, etc.
If you are encountering an issue with a port, follow the guidance listed below:
1. Read the README
Make sure you have read and followed the README. Every port will have this
file, explaining how to install the theme or modify the application to install
Catppuccin. It is shown by default when you visit a GitHub repository.
2. Raise a GitHub Issue
Raise a GitHub issue on the relevant port's repository. If you have followed the
README and are still having trouble applying Catppuccin, raise a GitHub issue
clearly explaining what you have tried and what you expect to happen.
Do not raise GitHub issues in catppuccin/catppuccin for bugs you find in our ports. For example, if you have an issue with the Catppuccin JetBrains theme, a GitHub issue should be raised on catppuccin/jetbrains.
We also highly recommend that you provide extra details like your operating
system, what version of the theme you installed, the configuration you applied,
was Mercury in retrograde when the issue occured?, etc. Of course, these are
not relevant to all ports, but some ports will require this information in order
for an issue to be raised and acted upon.
3. Join the Discord
Join our Discord server! If you feel like your issue has gone stale or you
don't feel comfortable raising a GitHub Issue, feel free to join our Discord
server! The Catppuccin community is active on Discord and you can post your
questions in our dedicated #support channel.
You can also ask for help and guidance on creating new ports to be transferred into the Catppuccin GitHub organisation. Often, this can streamline the process as the feedback loop is usually faster on Discord compared to GitHub and more people will be exposed to and/or interested in your work.