CONTRIBUTING.md

March 17, 2026 · View on GitHub

Contributing

Please read these short instructions before submitting a theme. Submit themes using the "Submit a theme" issue template (do NOT open PRs manually). The project automation will parse your issue and create a PR.

Quick rejection reasons (maintainers will reject or request fixes for):

  • Inconsistent or unreadable colors.
  • Missing or broken configuration fields.
  • Poor contrast or layout issues.
  • Not following the required file naming / structure conventions.
  • Excessive commented-out code or very large commented blocks in files.
  • Missing or broken preview image.
  • Missing or very poor README file (the README should include a preview of the theme, as well as any relevant information about the theme, such as the fonts needed).
  • Not following the required formatting for config.yaml (e.g. missing fields, incorrect indentation, etc.).
  • Bad UI choices (e.g. using a very small font size, using a very large font size, using a very small or very large bar height, etc.).
  • Quality of the theme is not up to the standards of the gallery.
  • Submitting a theme that is very similar to an existing theme without significant improvements or differences.
  • Submitting a theme that is not original or is a copy of an existing theme without proper attribution.
  • Submitting a theme that is not compatible with the latest version of YASB or has known bugs that have not been fixed.
  • Submitting a theme that does not follow the required file structure or naming conventions.

Checklist before opening the issue:

  • Paste your final styles.css into the Theme Styles field (no big commented blocks).
  • Paste config.yaml into the Theme Config field and keep it well formatted.
  • Provide a direct PNG link for the preview image in the Image field.
  • Add a short Readme in the Readme field.

If a submission is rejected the maintainers will leave a clear comment explaining what to fix; PRs may be closed after 14 days without response.

Thank you for contributing — clean, readable themes make the gallery better for everyone.