2021-11-07 03:32:08 +00:00
|
|
|
# Contributing!
|
|
|
|
|
|
|
|
|
|
🎉 First off, thanks for taking the time to contribute! 🎉
|
|
|
|
|
|
|
|
|
|
## Guidelines
|
|
|
|
|
|
2023-01-26 18:53:05 +00:00
|
|
|
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.
|
2021-11-07 03:32:08 +00:00
|
|
|
|
2023-01-26 18:53:05 +00:00
|
|
|
- Use the `.editorconfig` file (located at the root of this project) on your editor to "maintain consistent coding
|
|
|
|
|
styles." For instructions on how to use this file refer to [EditorConfig's website](https://editorconfig.org/).
|
2021-11-07 03:32:08 +00:00
|
|
|
|
|
|
|
|
## Recommendations
|
|
|
|
|
|
2024-08-05 13:43:42 +00:00
|
|
|
- Create a [topic branch](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#_topic_branch) on your fork for your
|
2023-01-26 18:53:05 +00:00
|
|
|
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
|
2023-05-02 22:09:11 +00:00
|
|
|
join our [Discord](https://discord.com/servers/catppuccin-907385605422448742) to ask any questions and clarify your understanding, we are
|
2023-01-26 18:53:05 +00:00
|
|
|
more than happy to help!
|
