Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (34 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

46 lines (34 loc) · 2.34 KB

Contributing to Project-K (KALI)

First, thank you for showing interest in the evolution of KALI. This project is a specialized AI ecosystem designed to bridge universal knowledge and physical fabrication.

⚖️ The KALI Standards (Immutable)

To maintain the project's high-integrity vision, all contributors must strictly adhere to these rules:

  1. Absolute "No Emoji" Policy: Emojis are prohibited in the codebase, comments, and commit messages. This is a technical requirement for operational consistency.
  2. Master Plan Traceability: Every significant change must be anchored to a phase in the KALI_MASTER_PLAN.md.
  3. Multi-AI Consensus: Core logic changes in the src/core directory require verification against multiple AI models to ensure pedagogical neutrality.
  4. Hardware Sovereignty: While you can run KALI on your own hardware, do not attempt to bypass the "Sovereign Mode" identifier logic.

🚀 Getting Started

  1. Clone the Repository: 
    git clone https://github.com/Adityavanjre/Project-K.git
cd Project-K
  2. Set Up Environment: 
    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt
  3. Configure .env: Copy .env.example to .env and configure your API keys. Define your SOVEREIGN_HARDWARE_ID to personalize your instance.

💠 Ways to Contribute

We welcome contributions across several specialized domains:

  • Development: Expand core Python logic (src/core), refine 3D hardware components (src/static/js/parts_lib.js), and optimize the Neural HUD.
  • Issues & Bugs: Report technical inconsistencies, logical gaps, or UI glitches using the repository's issue templates.
  • Training & Data: Assist in refining KALI's pedagogical paths and improving the "Great Council" consensus logic.
  • Improvements: Propose optimizations for the Fabrication Lifecycle and visual clarity in 3D logic rendering.

🛠️ Submission Process

  1. Fork the project.
  2. Create a Branch (e.g., feat/phase-15-sync-cycle).
  3. Implement your changes following the aesthetic and technical guidelines in README.md.
  4. Submit a Pull Request with a detailed technical breakdown. No emojis in the PR title or description.

Sir, we are building the future together.