catppuccin-userstyles/docs/CONTRIBUTING.md
Adrian Karlén 15adf7c8fe
docs: add version info to general recommendations (#208)
* docs: add version info to general recommendations

* docs: rephrase reason for updating version
2023-09-21 14:30:26 +01:00

1.5 KiB

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
  2. Other improvements: These should follow the recommendations below, to help improve the chances of a merged PR.

General Recommendations

  • Create a topic branch on your fork for your specific PR.
  • Consider using conventionalcommits.org's rules for creating explicit and meaningful commit messages.
  • Update the version in the ==UserStyle== header of the css-file. This is to enable version control of the style.
  • If it's your first time contributing to a project then you should look to the popular 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 to ask any questions and clarify your understanding, we are more than happy to help!