Contributing

This project is maintained for the benefit of the community, and we’re grateful for any contributions to help improve it. We require that contributors:

• Be kind to all 💛
• Follow the Code of Conduct
• Respect the time and effort of maintainers and other contributors

What to contribute

We welcome and appreciate both code and non-code contributions, including:

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

Even the smallest changes can help free up our time for general maintenance and promote a positive, functional and accessible experience for everyone ✨

Bug reports & feature requests

Before opening an issue, search existing issues, including closed ones.

If it already exists:

• Please use GitHub’s reactions to promote the issue
• Reserve comments for specific information that could help address the problem

Otherwise:

Open an issue containing the following:

Bug reports:

• As much context as possible on the issue and how and when it occurs
• Steps to reproduce the issue
• Crash reports, screenshots, or error logs if possible
• Software versions if applicable

Feature requests:

• Description of the requested feature or change
• Supporting reasoning or context if appropriate

We can’t guarantee issues will be resolved right away, but we deeply appreciate suggestions and reports and give serious consideration to all requests.

Code & documentation contributions

If adding a new theme, please use our template

Implement your changes:

• Don’t add non-project metafiles. See global gitignore for best practices
• Fork the repository and commit changes to a topic branch with a descriptive name
• If possible, please bundle changes into logical, focused branches and commits
• Adhere to existing code format, e.g. lowercase commit messages

Submit a PR:

• Submit a pull request to the main repo with your changes and any supporting information, explanation, or context you feel is appropriate
• If your submission is related to an issue, reference it in the PR description, e.g. fixes #123

Thanks

Thank you for your support & happy contributing! 🌸