Skip to content

chore: add pull request template picker and userstyle update template #308

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sgoudham merged 1 commit into from
Nov 14, 2023
Merged

chore: add pull request template picker and userstyle update template #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/userstyle-creation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!-- Replace "Website" with a markdown link to the website that you have themed. -->

## 🎉 Theme for Website 🎉

<!--
You should give a short description of the website that you have themed.
E.g. YouTube is a video sharing platform that allows users to upload, view, and share videos.

You should also attach some screenshots of the themed website, show it off!
-->

## 💬 Additional Comments 💬

<!--
Include any difficulties you had theming this port, or any general comments that would be useful for the reviewer to know.
Feel free to leave this section empty if you don't have anything more to say.
-->

## 🗒 Checklist 🗒

- [ ] I have read and followed Catppuccin's [submission guidelines](https://github.com/catppuccin/userstyles/blob/main/docs/userstyle-creation.md).
- [ ] 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.
- [ ] I have ensured that the new directory is in **lower-kebab-case**.
- [ ] I have followed the template and kept the preprocessor as [LESS](https://lesscss.org/#overview).
- [ ] I have made sure to update the
[`userstyles.yml`](https://github.com/catppuccin/userstyles/blob/main/src/userstyles.yml)
file with information about the new userstyle.
- [ ] I have included the following files:
- `catppuccin.user.css` - all the CSS for the userstyle, based on the
template.
- `assets/mocha.webp`, `assets/macchiato.webp`, `assets/frappe.webp` and
`assets/latte.webp` - individual screenshots of the themed website, in all 4
Catppuccin flavors.
- `catwalk.webp` - image of all individual screenshots stitched together,
generated via [catwalk](https://github.com/catppuccin/toolbox#-catwalk).
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/userstyle-update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## 🔧 What does this fix? 🔧

<!--
You should give a short description of the fixes/updates implemented in your PR, and add "Closes #<ISSUE-NUMBER>" below if so
E.g. Fixes unthemed buttons on the home page.
-->

## 🗒 Checklist 🗒

- [ ] I have read and followed Catppuccin's [contributing guidelines](https://github.com/catppuccin/userstyles/blob/main/docs/CONTRIBUTING.md).
- [ ] I have updated the version appropriately in the `==UserStyle==` header of the `catppuccin.user.css` file.
39 changes: 4 additions & 35 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,6 @@
<!-- DELETE THIS TEMPLATE IF YOUR PULL REQUEST DOES NOT ADD A USERSTYLE -->
Please go the the `Preview` tab and open the appropriate pull request template.

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

## 🎉 Theme for Website 🎉

<!--
You should give a short description of the website that you have themed.
E.g. YouTube is a video sharing platform that allows users to upload, view, and share videos.

You should also attach some screenshots of the themed website, show it off!
-->

## 💬 Additional Comments 💬

<!--
Include any difficulties you had theming this port, or any general comments that would be useful for the reviewer to know.
Feel free to leave this section empty if you don't have anything more to say.
-->

## 🗒 Checklist 🗒

- [ ] I have read and followed Catppuccin's [submission guidelines](https://github.com/catppuccin/userstyles/blob/main/docs/userstyle-creation.md).
- [ ] 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.
- [ ] I have ensured that the new directory is in **lower-kebab-case**.
- [ ] I have followed the template and kept the preprocessor as [LESS](https://lesscss.org/#overview).
- [ ] I have made sure to update the
[`userstyles.yml`](https://github.com/catppuccin/userstyles/blob/main/src/userstyles.yml)
file with information about the new userstyle.
- [ ] I have included the following files:
- `catppuccin.user.css` - all the CSS for the userstyle, based on the
template.
- `assets/mocha.webp`, `assets/macchiato.webp`, `assets/frappe.webp` and
`assets/latte.webp` - individual screenshots of the themed website, in all 4
Catppuccin flavors.
- `catwalk.webp` - image of all individual screenshots stitched together,
generated via [catwalk](https://github.com/catppuccin/toolbox#-catwalk).
- [Adding a new userstyle?](?expand=1&template=userstyle-creation.md)
- [Updating/fixing an existing userstyle?](?expand=1&template=userstyle-update.md)