Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (30 loc) · 1.71 KB

CONTRIBUTING.md

File metadata and controls

45 lines (30 loc) · 1.71 KB
Raw

🤝 Contributing to Crystal Studio Labs

Thank you for your interest in contributing to Crystal Studio Labs! We build high-performance open-source developer tools, CLI systems, and local-first software applications with a focus on simplicity, performance, and security.

📜 Core Philosophy & Standards

  1. Simple Over Complex: Avoid unnecessary third-party dependencies and over-engineering. Focus on clean, lightweight implementations.
  2. Clean UI & Ergonomics: Terminal UI tools and web interfaces must maintain high contrast, crisp typography, and intuitive spatial layouts.
  3. Security & Quality First: Code changes submitted via Pull Request are subject to automated verification via ARGUS (Automated Review & Governance Unit System).

🛠️ Getting Started

1. Repository Setup

Fork the target repository and clone it locally:

git clone https://github.com/YOUR_USERNAME/Crystal-Studio-Labs.github.io.git
cd Crystal-Studio-Labs.github.io

2. Branch Naming Convention

Create a feature or bugfix branch off main:

  • feat/feature-name
  • fix/bugfix-description
  • docs/documentation-update

🔍 Pull Request Guidelines

Before submitting a Pull Request:

  1. Ensure all code compiles cleanly and passes local linters/tests.
  2. Maintain zero dead code, unresolved placeholders, or hardcoded secrets.
  3. Provide a clear PR title and descriptive overview of your changes.

ARGUS will run automated code review and architectural validation against your PR. All PRs require review and approval by repository maintainers prior to merging into main.

💬 Community & Help

Join our community on Discord or open a discussion issue on GitHub.