Skip to content

Commit de543e6

Browse files
authored
docs: add pull request template picker and userstyle update template (catppuccin#308)
1 parent 8db4b76 commit de543e6

3 files changed

Lines changed: 50 additions & 35 deletions

File tree

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<!-- Replace "Website" with a markdown link to the website that you have themed. -->
2+
3+
## 🎉 Theme for Website 🎉
4+
5+
<!--
6+
You should give a short description of the website that you have themed.
7+
E.g. YouTube is a video sharing platform that allows users to upload, view, and share videos.
8+
9+
You should also attach some screenshots of the themed website, show it off!
10+
-->
11+
12+
## 💬 Additional Comments 💬
13+
14+
<!--
15+
Include any difficulties you had theming this port, or any general comments that would be useful for the reviewer to know.
16+
Feel free to leave this section empty if you don't have anything more to say.
17+
-->
18+
19+
## 🗒 Checklist 🗒
20+
21+
- [ ] I have read and followed Catppuccin's [submission guidelines](https://github.com/catppuccin/userstyles/blob/main/docs/userstyle-creation.md).
22+
- [ ] I have made a new directory underneath `/styles/<name-of-website>` containing the contents of the [`/template`](https://github.com/catppuccin/userstyles/blob/main/template/) directory.
23+
- [ ] I have ensured that the new directory is in **lower-kebab-case**.
24+
- [ ] I have followed the template and kept the preprocessor as [LESS](https://lesscss.org/#overview).
25+
- [ ] I have made sure to update the
26+
[`userstyles.yml`](https://github.com/catppuccin/userstyles/blob/main/src/userstyles.yml)
27+
file with information about the new userstyle.
28+
- [ ] I have included the following files:
29+
- `catppuccin.user.css` - all the CSS for the userstyle, based on the
30+
template.
31+
- `assets/mocha.webp`, `assets/macchiato.webp`, `assets/frappe.webp` and
32+
`assets/latte.webp` - individual screenshots of the themed website, in all 4
33+
Catppuccin flavors.
34+
- `catwalk.webp` - image of all individual screenshots stitched together,
35+
generated via [catwalk](https://github.com/catppuccin/toolbox#-catwalk).
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## 🔧 What does this fix? 🔧
2+
3+
<!--
4+
You should give a short description of the fixes/updates implemented in your PR, and add "Closes #<ISSUE-NUMBER>" below if so
5+
E.g. Fixes unthemed buttons on the home page.
6+
-->
7+
8+
## 🗒 Checklist 🗒
9+
10+
- [ ] I have read and followed Catppuccin's [contributing guidelines](https://github.com/catppuccin/userstyles/blob/main/docs/CONTRIBUTING.md).
11+
- [ ] I have updated the version appropriately in the `==UserStyle==` header of the `catppuccin.user.css` file.

.github/pull_request_template.md

Lines changed: 4 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,6 @@
1-
<!-- DELETE THIS TEMPLATE IF YOUR PULL REQUEST DOES NOT ADD A USERSTYLE -->
1+
Please go the the `Preview` tab and open the appropriate pull request template.
22

3-
<!-- Replace "Website" with a markdown link to the website that you have themed. -->
3+
Are you...
44

5-
## 🎉 Theme for Website 🎉
6-
7-
<!--
8-
You should give a short description of the website that you have themed.
9-
E.g. YouTube is a video sharing platform that allows users to upload, view, and share videos.
10-
11-
You should also attach some screenshots of the themed website, show it off!
12-
-->
13-
14-
## 💬 Additional Comments 💬
15-
16-
<!--
17-
Include any difficulties you had theming this port, or any general comments that would be useful for the reviewer to know.
18-
Feel free to leave this section empty if you don't have anything more to say.
19-
-->
20-
21-
## 🗒 Checklist 🗒
22-
23-
- [ ] I have read and followed Catppuccin's [submission guidelines](https://github.com/catppuccin/userstyles/blob/main/docs/userstyle-creation.md).
24-
- [ ] I have made a new directory underneath `/styles/<name-of-website>` containing the contents of the [`/template`](https://github.com/catppuccin/userstyles/blob/main/template/) directory.
25-
- [ ] I have ensured that the new directory is in **lower-kebab-case**.
26-
- [ ] I have followed the template and kept the preprocessor as [LESS](https://lesscss.org/#overview).
27-
- [ ] I have made sure to update the
28-
[`userstyles.yml`](https://github.com/catppuccin/userstyles/blob/main/src/userstyles.yml)
29-
file with information about the new userstyle.
30-
- [ ] I have included the following files:
31-
- `catppuccin.user.css` - all the CSS for the userstyle, based on the
32-
template.
33-
- `assets/mocha.webp`, `assets/macchiato.webp`, `assets/frappe.webp` and
34-
`assets/latte.webp` - individual screenshots of the themed website, in all 4
35-
Catppuccin flavors.
36-
- `catwalk.webp` - image of all individual screenshots stitched together,
37-
generated via [catwalk](https://github.com/catppuccin/toolbox#-catwalk).
5+
- [Adding a new userstyle?](?expand=1&template=userstyle-creation.md)
6+
- [Updating/fixing an existing userstyle?](?expand=1&template=userstyle-update.md)

0 commit comments

Comments
 (0)