catppuccin/CONTRIBUTING.md
Hamothy b9bbd77c7f
docs: restructure & improve contrib docs (#1876)
* 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>
2023-01-26 19:53:05 +01:00

1.2 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.

  • 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.

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.
  • 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!