Contributing

If you discover issues, have ideas for improvements or new features, please report them to the issue tracker of the repository or submit a pull request. Please, try to follow these guidelines when you do so.

Issue reporting

• Check that the issue has not already been reported.
• Check that the issue has not already been fixed in the latest code (a.k.a. main).
• Be clear, concise and precise in your description of the problem.
• Open an issue with a descriptive title and a summary in grammatically correct, complete sentences.
• Include any relevant code to the issue summary.
• Include a screenshot illustrating the issue.

Pull requests

• Read how to properly contribute to open source projects on Github.
• Use a topic branch to easily amend a pull request later, if necessary.
• Write good commit messages.
• Mention related tickets in the commit messages (e.g. [Fix #N] Add missing autoload cookies)
• Update the changelog.
• Use the same coding conventions as the rest of the project.
• Align new or updated faces with the official Catppuccin style guide. When the guide doesn't cover a specific face, pick the closest palette slot by role (e.g. functions → blue, keywords → mauve, strings → green) and mention your reasoning in the PR.
• Verify your Emacs Lisp code with checkdoc (C-c ? d).
• Run the test suite with eldev buttercup and, where practical, add a test for the behavior you're changing.
• Add a before/after screenshot illustrating visually your changes.
• Open a pull request that relates to only one subject with a clear title and description in grammatically correct, complete sentences.