Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
143 lines (98 loc) · 6.09 KB

CONTRIBUTING.md

File metadata and controls

143 lines (98 loc) · 6.09 KB

Contributing to Mayros

Welcome to the Mayros project! ⚡🛡️

Quick Links

Maintainers

How to Contribute

  1. Bugs & small fixes → Open a PR!
  2. New features / architecture → Start a GitHub Discussion or ask in Discord first
  3. Questions → Discord #setup-help

Before You PR

  • Test locally with your Mayros instance
  • Run tests: pnpm build && pnpm check && pnpm test
  • Ensure CI checks pass
  • Keep PRs focused (one thing per PR; do not mix unrelated concerns)
  • Describe what & why

Control UI Decorators

The Control UI uses Lit with legacy decorators (current Rollup parsing does not support accessor fields required for standard decorators). When adding reactive fields, keep the legacy style:

@state() foo = "bar";
@property({ type: Number }) count = 0;

The root tsconfig.json is configured for legacy decorators (experimentalDecorators: true) with useDefineForClassFields: false. Avoid flipping these unless you are also updating the UI build tooling to support standard decorators.

AI/Vibe-Coded PRs Welcome! 🤖

Built with Codex, Claude, or other AI tools? Awesome - just mark it!

Please include in your PR:

  • Mark as AI-assisted in the PR title or description
  • Note the degree of testing (untested / lightly tested / fully tested)
  • Include prompts or session logs if possible (super helpful!)
  • Confirm you understand what the code does

AI PRs are first-class citizens here. We just want transparency so reviewers know what to look for.

Current Focus & Roadmap 🗺

We are currently prioritizing:

  • Stability: Fixing edge cases in channel connections (WhatsApp/Telegram).
  • UX: Improving the onboarding wizard and error messages.
  • Skills: For skill contributions, head to Skills Hub — the community hub for Mayros skills.
  • Performance: Optimizing token usage and compaction logic.

Check the GitHub Issues for "good first issue" labels!

Maintainers

We're selectively expanding the maintainer team. If you're an experienced contributor who wants to help shape Mayros's direction — whether through code, docs, or community — we'd like to hear from you.

Being a maintainer is a responsibility, not an honorary title. We expect active, consistent involvement — triaging issues, reviewing PRs, and helping move the project forward.

Still interested? Email contributing@apilium.com with:

  • Links to your PRs on Mayros (if you don't have any, start there first)
  • Links to open source projects you maintain or actively contribute to
  • Your GitHub, Discord, and X/Twitter handles
  • A brief intro: background, experience, and areas of interest
  • Languages you speak and where you're based
  • How much time you can realistically commit

We welcome people across all skill sets — engineering, documentation, community management, and more. We review every human-only-written application carefully and add maintainers slowly and deliberately. Please allow a few weeks for a response.

Report a Vulnerability

We take security reports seriously. Report vulnerabilities directly to the repository where the issue lives:

For issues that don't fit a specific repo, or if you're unsure, email security@apilium.com and we'll route it.

Required in Reports

  1. Title
  2. Severity Assessment
  3. Impact
  4. Affected Component
  5. Technical Reproduction
  6. Demonstrated Impact
  7. Environment
  8. Remediation Advice

Reports without reproduction steps, demonstrated impact, and remediation advice will be deprioritized. Given the volume of AI-generated scanner findings, we must ensure we're receiving vetted reports from researchers who understand the issues.