Skip to content

Latest commit

 

History

History
51 lines (32 loc) · 3.03 KB

CONTRIBUTING.md

File metadata and controls

51 lines (32 loc) · 3.03 KB
Raw

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

All types of contributions are encouraged and welcome. 💜 Though please make sure to read through the following guidelines before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. Besides the creation and maintenance of ports we appreciate all sorts of code and non-code contributions. These include but are not limited to:

  • Typo fixes
  • Documentation improvements
  • Pull request reviews
  • Feature requests
  • Opinions & suggestions

 

✔️ 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 main branch.
  • 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.
  • Use conventionalcommits.org's rules for creating explicit and meaningful commit messages.

When contributing to this project, you must agree that you have authored 100% of the content, (or) that you have the necessary rights to the content and that the content you contribute may be provided under the projects MIT license.

 

💡 Recommendations

  • Create a topic branch on your fork for your specific PR.
  • Check the Styleguide document for a rough outline of how to apply the palette.
  • If it's your first time contributing to a project then read About pull requests on Github's docs.

 

🤔 I Have a Question

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions, depending on what seems relevant.