You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
🎉 First off, thanks for taking the time to contribute! 🎉
4
-
5
-
## Guidelines
6
-
7
-
The following is a set of guidelines for contributing to this repository. Use
8
-
your best judgment, and feel free to propose changes to this document in a pull
9
-
request.
10
-
11
-
> [!IMPORTANT]
12
-
> For new userstyles, make sure to see [userstyle-creation.md](./userstyle-creation.md) after reading this.
3
+
If it is your first time contributing to a project on GitHub, please see the popular [first-contributions](https://github.com/firstcontributions/first-contributions) repository. This will give you hands-on experience with the features of GitHub required to make a contribution. As always, feel free to join our [Discord](https://discord.com/servers/catppuccin-907385605422448742) to ask any questions and clarify your understanding, we are more than happy to help!
13
4
14
5
## Development environment
15
6
@@ -21,35 +12,23 @@ When editing a userstyle, we suggest setting up live reloading so your local cha
21
12
22
13
### Assessing websites
23
14
24
-
Some websites are, unfortunately, simply not meant for userstyles. For example, websites that have auto-generated classes (`aeN WR beA nH oy8Mbf`, `cfb2a888`, etc.) lead to unreadable and unmaintainable userstyles — they break quickly and are difficult for contributors besides the maintainer to update/maintain. For those reasons we recommend not attempting to theme such sites.
15
+
Some websites are unfortunatelynot ideal for userstyles. Websites with auto-generated classes - think `aeN WR beA nH oy8Mbf`, `cfb2a888`, etc. - lead to unreadable and unmaintainable userstyles that break quickly and are difficult to update/maintain. Such userstyles, if created, will also take longer to review and merge.
25
16
26
-
### Root variables
17
+
### CSS variables
27
18
28
-
While writing a userstyle, you may have come across [custom properties / CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/--*), typically wrapped in a `:root` selector. We refer to these variables as "root variables", and they can be thought of as global variables used all across a website. For Catppuccin userstyles, we prefer that these variables are themed (if they exist) rather than individual elements. As the website hopefully uses these variables themselves, it saves yourself a lot of work in theming and maintaining the userstyle.
19
+
While writing a userstyle, you may have come across [CSS variables](https://developer.mozilla.org/en-US/docs/Web/CSS/--*) (or "custom properties"). We prefer that these variables are used if present, rather than theming individual elements. As the website typically uses these variables itself, it saves a lot of work in theming and maintaining the userstyle.
29
20
30
21
### Opinionated changes
31
22
32
23
When writing or updating a userstyle, it is important to keep in mind that different users have different preferences. To avoid lengthy discussion over user interface aesthetics, we have a set of rules for what a userstyle may include; importantly, **changes to font, layout, padding, margin, display, and in general anything besides color tweaks are prohibited.**
33
24
34
-
### General recommendations
25
+
### Pull requests
35
26
36
27
- Create a [topic branch](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#_topic_branch) on your fork for your specific PR.
37
-
- Catppuccin uses the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
38
-
standard for creating explicit and meaningful commit messages. This repository
39
-
requires pull request _titles_ to be in the conventional commit format,
40
-
however we do not require it for individual commits within a pull request.
41
-
- Update the version in the `==UserStyle==` header of the `catppuccin.user.css`
42
-
file. This is to enable version control of the style.
43
-
- If it's your first time contributing to a project then you should look to the
44
-
popular [first-contributions](https://github.com/firstcontributions/first-contributions)
45
-
repository on GitHub. This will give you hands-on experience with the features
46
-
of GitHub required to make a contribution. As always, feel free to join our [Discord](https://discord.com/servers/catppuccin-907385605422448742) to ask
47
-
any questions and clarify your understanding, we are more than happy to help!
48
-
- Changes to docs may need to use [marksman](https://github.com/artempyanykh/marksman) to generate the table of contents.
28
+
- Catppuccin uses the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) standard for creating explicit and meaningful commit messages. This repository requires pull request _titles_ to be in the conventional commit format, however we do not require it for individual commits within a pull request.
29
+
- It's better to have a draft pull request than no pull request at all. Having a draft lets others know that a userstyle is being worked on, and gives the opportunity for people to try it out ahead of time (if they really want it themed!).
49
30
50
-
## Pull request review process
51
-
52
-
It's better to have a draft pull request than no pull request at all. Having a draft lets others know that a userstyle is being worked on, and gives the opportunity for people to try it out ahead of time (if they really want it themed!).
31
+
### Contribution review process
53
32
54
33
```mermaid
55
34
graph TD;
@@ -63,7 +42,5 @@ graph TD;
63
42
F -->|Changes made| F;
64
43
E -->|Approved by userstyles staff| K;
65
44
F -->|Approved by maintainer or userstyles staff| L[Merged by maintainer];
66
-
K[Waiting period*] --> M[Merged by userstyles staff];
45
+
K[Review period] --> M[Merged by userstyles staff];
67
46
```
68
-
69
-
\*A waiting period is usually started if a website is particularly complex or for any other reason could not be thoroughly/completely tested. Waiting periods typically last between 1 and 2 days.
0 commit comments