Skip to content

Contributing

Jarvis is an open-source community-driven project. Every contribution matters.

Ways to contribute

  • Report bugs

    Open a GitHub issue with a minimal reproduction.

  • Propose features

    Start a discussion before coding, especially for big ideas.

  • Improve docs

    Typos, missing examples, IT ↔ EN translations.

  • Add a language

    We support IT + EN today. New languages are very welcome.

  • Build a plugin

    See plugins/_template/ for the starter scaffold.

  • Integrate a device

    Wearables, glasses, holographic displays. See agents/.

  • Write tests

    Unit, integration, E2E. Target: 80%+ coverage.

  • Security audits

    Security reports go via email, not in public issues.

Workflow

  1. Fork the repository
  2. Descriptive branch (feat/..., fix/..., docs/...)
  3. Commits using Conventional Commits
  4. Push + Pull Request against main
  5. Code review + merge

Full details in CONTRIBUTING.md.

Golden rules

  • Small files > big files (200–400 lines typical)
  • Immutable structures by default
  • Explicit error handling
  • Validate input at system boundaries
  • Never hardcode secrets — .env is always gitignored
  • Comments only when the why is non-obvious

Code of Conduct

The project adopts the Contributor Covenant. Respectful and inclusive behaviour is expected from everyone.

Recognition

Every contributor is listed in the README and the documentation. Your work matters.

"Don't wait for permission. Open a PR." — A truth of open-source software