Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (38 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

56 lines (38 loc) · 2.33 KB
Raw

Contributing to Loci

Thanks for your interest in Loci! We welcome contributions of all kinds.

How to Contribute

Bug Reports & Feature Requests

Open an issue with:

  • Bug: Steps to reproduce, expected vs actual behavior
  • Feature: Use case and proposed solution

Code & Documentation

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/your-idea
  3. Make your changes
  4. Run node --test tests/*.test.js; use temporary brains and explicit --home for install tests
  5. Submit a pull request

Please open an issue first for large changes so we can discuss the approach.

What to Work On

  • Templates: Improve module READMEs, add new templates
  • Dashboard: UI improvements, new visualizations
  • Documentation: Guides, tutorials, translations
  • Slash commands: Improve existing commands or propose new ones
  • Integrations: Support for other AI tools beyond Claude Code

Guidelines

  • Keep changes focused — one feature/fix per PR
  • Follow existing file naming conventions (YYYY-MM-DD-slug.md for decisions, etc.)
  • Use YAML frontmatter for all content files
  • Test install/upgrade if you change entry generation or data initialization
  • Keep the README Chinese-first with an English option; code comments can use English

Project Structure

See How It Works for the full system overview. Key files:

  • LOCI.md — Short entry installed in each agent
  • LOCI-RULES.md — The complete operation manual
  • scripts/loci-install.js / scripts/loci-update.js — Cross-platform installation and protected upgrades
  • templates/commands/ — Slash command definitions
  • .loci/dashboard/server.js — Dashboard server (run with node .loci/dashboard/server.js, port 8765)
  • examples/alex/ — Demo data for new users

User guide

Edit docs/user-guide.md, then run node scripts/build-user-guide.js and commit the generated site/handbook/index.html and architecture asset together. The reader styles and behavior live in site/handbook/style.css and app.js. Preview the site/ directory with a local HTTP server. Keep examples fictional and never copy private brain files or article archives into site/.

License

By contributing, you agree that your contributions will be licensed under the MIT License.