1c16ae7dd1
* fix: use correct shield for issues by label * style: run `deno fmt` * build(CODEOWNERS): remove extra `#` and `\n` * docs: remove escaping `.` for folders * docs: commit to using `userstyle` Originally, we wanted to avoid using the word userstyle in case non-developers were confused. However, given that the name of the repository is catppuccin/userstyles and there are now explanations for what a userstyle is. I believe we should be more consistent and commit to using the word. * build(userstyle.yml): shorten issue template This commit uses the abbreviated YAML list syntax to auto-populate the labels. This will ensure that this file remains easy to scroll as more userstyles are added. * chore: use raw link for schema Using a relative link only works when the user has locally cloned the repository. This commit changes it back to a raw link so that it overcomes this limitation. * build: refine commit msg in `git-auto-commit-action" The current commit message is quite verbose and co-authors the original author. In @nekowinston's words: "there's no reason i'm co-authored when i merge a PR in that changes a single line in the readme :baldkek:" This commit reduces the verbosity of the commit message and doesn't co-author the merger. * build(issue-labeler.yml): shorten file Please see the commit description of 4a1326983f1e1a3bbe663f4aa16b6e19f8df8da8 * docs: highlight text as bold We want to draw the user's attention to specific parts of the page. For the CONTRIBUTING.md, we want to make sure their eyes are down towards "New Userstyles." For the userstyle-creation.md, we want to make sure that the user knows READMEs are auto-generated. * chore: update `deno.lock` * chore: generate health files
34 lines
1.4 KiB
Markdown
34 lines
1.4 KiB
Markdown
# Contributing!
|
|
|
|
🎉 First off, thanks for taking the time to contribute! 🎉
|
|
|
|
## Guidelines
|
|
|
|
The following is a set of guidelines for contributing to this repository. Use
|
|
your best judgment, and feel free to propose changes to this document in a pull
|
|
request.
|
|
|
|
## Types of PRs
|
|
|
|
It is important to note that there are **two types of PRs** for this repository:
|
|
|
|
1. **New Userstyles:** Please see [userstyle-creation.md](userstyle-creation.md)
|
|
2. **Other improvements:** These should follow the recommendations below, to help
|
|
improve the chances of a merged PR.
|
|
|
|
## General Recommendations
|
|
|
|
- Create a
|
|
[topic branch](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#_topic_branch)
|
|
on your fork for your specific PR.
|
|
- Consider using
|
|
[conventionalcommits.org](https://www.conventionalcommits.org/en/v1.0.0/)'s
|
|
rules for creating explicit and meaningful commit messages.
|
|
- If it's your first time contributing to a project then you should look to the
|
|
popular
|
|
[first-contributions](https://github.com/firstcontributions/first-contributions)
|
|
repository on GitHub. 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!
|