Skip to content
This repository was archived by the owner on Jun 8, 2026. It is now read-only.

CONTRIBUTING.md

Latest commit

 

History

History
33 lines (25 loc) · 1.61 KB

CONTRIBUTING.md

File metadata and controls

33 lines (25 loc) · 1.61 KB
Raw

Contributing to Latha DB

Thank you for your interest in contributing to Latha DB! We strictly prioritize Human Scalability and professional standards. Please review our policies before submitting code.

1. License Compliance & Legal

Latha DB is an Open Source project.

  • License: You are free to fork, modify, and commercialize this project under the Apache License 2.0.
  • Attribution: You MUST retain the original NOTICE file and all copyright headers attributing the work to 'Defer Studios'.

2. The "Human-Scalable" Code Policy

We believe software must be maintainable by humans, not just machines.

✅ Allowed AI Usage

  • Using AI (ChatGPT/Claude/etc.) to:
    • Brainstorm architectural ideas.
    • Explain complex algorithms (e.g., Vector math).
    • Debug specific error messages.
    • Generate test cases.

🚫 Forbidden AI Behaviors

  • Copy-Pasting Raw Code: Do NOT copy-paste blocks of code directly from an LLM into the codebase without understanding and refining them.
  • Spaghetti Code: AI often generates verbose or convoluted logic. Resulting code must be clean, refactored, and follow our style guide.

Rationale: If an AI writes it, but a human cannot easily read/debug it, it is technical debt. We will reject PRs that look like unverified AI dumps.

3. Pull Request Process

  1. Branch: Create a feature branch (e.g., feature/vector-search).
  2. Describe: Clearly explain what you changed and why.
  3. Test: Ensure all unit tests pass (java -cp bin com.lathadb.SelfTest).
  4. Review: Be ready to iterate based on feedback.

Build meaningful software.