Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
52 lines (37 loc) · 2.18 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 2.18 KB

Contributing to Xscriptor OpenCode

Thank you for your interest in contributing to this project. Contributions are welcome whether you want to add new color schemes, improve existing themes, fix bugs, or enhance documentation.

How to Contribute

Reporting Issues

If you find a bug or have a suggestion, open an issue at github.com/xscriptor/opencode/issues. Include as much detail as possible:

  • A clear description of the issue
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots if applicable

Adding a New Theme

  1. Define your ANSI color palette (16 colors) in colors.md following the existing format
  2. Create a corresponding JSON file in themes/xscriptor-themes/colors/ using the OpenCode theme specification
  3. Add the theme name to the THEMES array in install.sh
  4. Update the tables in README.md and themes/xscriptor-themes/README.md

Code Standards

  • Theme JSON files must be valid JSON and pass python3 -c "import json; json.load(open('file.json'))"
  • Follow the existing structure: defs for color references, theme for semantic mappings
  • Include the $schema field pointing to https://opencode.ai/theme.json
  • Shell scripts must be POSIX-compatible and pass shellcheck

Pull Request Process

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-theme
  3. Commit your changes with clear messages
  4. Push to your fork and open a pull request
  5. Ensure all checks pass (JSON validation, shellcheck)

Code of Conduct

All contributors must adhere to the Code of Conduct. Be respectful, constructive, and collaborative.

Contact

Maintainer: x@xscriptor