mirror of
https://github.com/catppuccin/catppuccin
synced 2024-11-26 05:20:20 +00:00
b9bbd77c7f
* docs: restructure & improve contrib docs * chore: rework samples code * docs: fix capitalization & brand names * docs: PR comments & try to standardise palette vs flavor * docs: add sample-programs * docs: update submission guidelines (refs: #1821) * refactor: tidy up docs Co-authored-by: winston <hey@winston.sh>
23 lines
1.2 KiB
Markdown
23 lines
1.2 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.
|
|
|
|
- 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/).
|
|
|
|
## Recommendations
|
|
|
|
- Create a [topic branch](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/invite/r6Mdz5dpFc) to ask any questions and clarify your understanding, we are
|
|
more than happy to help!
|