Mirrors/catppuccin
2
0
Fork 0
mirror of https://github.com/catppuccin/catppuccin synced 2024-11-26 13:30:21 +00:00
Code Issues Projects Releases Packages Wiki Activity
catppuccin/CONTRIBUTING.md
Pocco81 5a18601d3b updated contributing
2022-05-25 20:41:44 -05:00

1.5 KiB
Raw Blame History

Contributing!

🎉 First off, thanks for taking the time to contribute! 🎉

Note: if you are here because you want to submit a port/learn how to port Catppuccin to a program please refer to the documentation

Guidelines

The following is a set of guidelines for contributing to this project. Use your best judgment, and feel free to propose changes to this document in a pull request.

  • PRs should go to the dev branch. Reasons:
    • If there is already stuff under development, then it's likely that a conflict may occur.
    • Releases/Deployment.
    • Documentation tends not to be updated by PRs.
    • Testing.
  • Use the .editorconfig file (located at the root of this project) on your editor so as 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 read About pull requests on Github's docs.

License

Any contribution will be published under the same licensing terms as the project itself.