Skip to content

Latest commit

 

History

History
48 lines (39 loc) · 2.63 KB

File metadata and controls

48 lines (39 loc) · 2.63 KB

Contributing

Contributions are welcome in the form of bug fixes, new themes, documentation, tooling, or workflow improvements.

This project has clear guidelines for AI usage.

Before contributing

Key expectations

  • All contributions must respect the design rules, naming conventions, color system, and keyboard-first mindset.
  • AI-generated code must be reviewed, modified, and fully understood, low-effort AI dumps will be rejected
  • Quality, maintainability and clarity matter more than speed.

Getting Started

  1. Fork this repository and clone it locally
  2. Install prerequisites
  3. Preview changes with local scripts or TUI/CLI apps
  4. Verify all design rules and visual consistency before committing

How to Contribute

Reporting Issues

  • Check for existing issues to avoid duplicates
  • Use the Bug Report Template
  • Include screenshots, terminal output, or error logs
  • Use descriptive titles (e.g., "kitty: cursor misaligned with transparency enabled")

Suggesting Features

  • Use the Feature Request Template
  • Be specific about what you want, why it matters, and how it fits Cybrcore's philosophy
  • Include mockups or examples if applicable

Submitting Pull Requests

  1. Fork and create a branch fix/<short-description>
  2. Test locally on Cybrpaper wallpapers, with transparency on/off
  3. Document any non-obvious config changes inline
  4. Submit PR with clear description

Contribution Types

  • Bug Fix: Resolve broken themes or misaligned elements
  • New Theme / Component: Must follow design philosophy
  • Documentation: Guides, examples, or README improvements
  • Tooling / Scripts: Installer scripts, preview scripts, CLI helpers

Acknowledgments

Every contribution counts. Even small fixes, documentation improvements, or suggestions improve the ecosystem. By contributing, you help Cybrcore evolve into a consistent, modular, lucid experience for Linux users everywhere.