catppuccin-userstyles/docs/CONTRIBUTING.md
sgoudham 8cfccfd837
feat: launch catppuccin/userstyles
Co-authored-by: rubyowo <perhaps-you-know@what-is.ml>
Co-authored-by: Andreas Grafen <andreas@grafen.info>
Co-authored-by: winston <hey@winston.sh>
Co-authored-by: Carsten Kragelund <carsten@kragelund.me>
Co-authored-by: Andreas Grafen <andreas@grafen.info>
Co-authored-by: Alaina <68250402+alaidriel@users.noreply.github.com>
Co-authored-by: jolheiser <john.olheiser@gmail.com>
2023-07-20 19:43:01 +01:00

21 lines
1.3 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!