1
0
mirror of https://github.com/gilbN/theme.park.git synced 2024-11-04 10:12:31 +01:00
theme.park/.github/CONTRIBUTING.md

30 lines
1.5 KiB
Markdown
Raw Normal View History

2021-08-08 18:09:00 +02:00
# Contributing to theme.park
- If you want to discuss changes, you can also bring it up in our Discord server
2021-08-09 21:45:35 +02:00
2021-08-08 18:09:00 +02:00
## New theme option
2021-08-09 21:45:35 +02:00
- The current variables in use can be found in any of the CSS files in `/CSS/variables/`
- New community contributed theme options will be placed in the `Community Themes` category on our docs page.
- Community themes are not officially supported but as long as they follow the same variable structure as the other theme options it should look fine on all applications.
- When contributing a new option, you must have example screeenshots of the theme being used. Preferrably at least 10 with the same image size. See examples on our [docs page](https://docs.theme-park.dev/community-themes/).
2021-08-08 18:09:00 +02:00
### Specials
Remember to also to change the variables in the the `Specials` section even if you dont use the application the variable refers to.
2021-08-09 21:45:35 +02:00
- `--arr-queue-color` Please refrain from using an orange/yellowish color on the variable as its confusing from a UX standpoint as the "arrs" use that color range when something is wrong in the queue.
2021-08-08 18:09:00 +02:00
## New application theme
2021-08-09 21:45:35 +02:00
- When creating a new theme for an application please test multiple theme options to make sure it looks good on all options not just your favorite.
- The PR must contain a screenshot of all the different theme options. Optionally you can also include screenshots with the community theme options.
2021-08-08 18:09:00 +02:00
## Bug fixes
2021-08-09 21:45:35 +02:00
- When submitting bugfixes please show a before and after screenshot of the fix, and a description of what the fix does.