Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (40 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

54 lines (40 loc) · 1.73 KB
Raw

Contributing to Awesome Omarchy

Quick guide for contributing to this curated list of Omarchy resources.

What to Include

✅ Yes: High-quality Omarchy plugins, themes, tools, guides, and related projects (5+ stars, actively maintained) ❌ No: Broken links, duplicates, unrelated content, or low-quality resources

How to Contribute

  1. Fork → Create branch → Add resource → Submit PR
  2. Use format: - [Name](link) - Brief description.
  3. Add to appropriate section (Official, Alternative, Plugins, Tools, Related, Community, Themes)
  4. Keep that section alphabetical by listing name
  5. Ensure links work and descriptions end with periods

Local Validation

Setup:

pip install pre-commit && pre-commit install
# No additional setup needed - all tools use npx

Usage:

pre-commit run --all-files  # Run all checks
pre-commit run typos        # Check spelling
python3 scripts/check-list-order.py --fix README.md  # Sort section lists
python3 scripts/check-min-stars.py README.md         # 5+ stars on new GitHub listings

This runs the same tools as CI: awesome-lint, markdown formatting, spell check, list order, min stars, and link validation.

Requirements

All Resources:

  • 5+ GitHub stars (exceptions for official/essential resources)
  • Active maintenance (recent commits/releases)
  • Working links and clear documentation
  • Relevant to Omarchy ecosystem

Descriptions:

  • Concise (1 sentence)
  • Start with capital, end with period
  • Describe function, not marketing

Example:

- [Midnight Theme](https://github.com/JaxonWright/omarchy-midnight-theme) - Dark theme optimized for OLED displays.

Questions? Open an issue