Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

53 lines (42 loc) · 2.59 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 Issue 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 Cybrland's philosophy
  • Include mockups or examples if applicable

Submitting Pull Requests

  1. Fork and create a branch:
    • feature/<short-description> or fix/<short-description>
  2. Follow Design Philosophy
  3. Test locally on Cybrpaper wallpapers, with transparency on/off
  4. Document any non-obvious config changes inline
  5. 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

Code of Conduct

All contributors must maintain a respectful and collaborative environment. Offensive, harassing, or disruptive behavior will not be tolerated.

This project follows the Contributor Covenant.

Acknowledgments

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