Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
101 lines (66 loc) · 6.08 KB

CONTRIBUTING.md

File metadata and controls

101 lines (66 loc) · 6.08 KB
Raw

Contributing to IRIS

Welcome to the IRIS development workspace. 👁️⚡

IRIS is an advanced, voice-first desktop assistant designed to streamline human-computer interaction through automated desktop actions. Right now, this is a solo-developed project, which means your contributions are incredibly valuable—but review time is limited.

🚨 CRITICAL ACCESS NOTICE: Commercial Core License Restrictions

We welcome public contributions to the IRIS Community UI! Developers can fork the repo, refine the React components, build custom front-end layouts, and submit Pull Requests under the MIT License. However, to run, test, or build workflows involving active automation logic, a valid local IRIS PRO License (₹499) is strictly required. Pull Requests altering, attempting to mock, or reverse-engineer core IPC bridges, V8 bytecode handlers, or licensing boundaries will be immediately closed. Developers wishing to incrementally study code snippets or unlock the full legacy v1 codebase can join the corresponding GitHub Sponsorship tiers up to IRIS MAX ($250/mo).

Please read this guide to ensure your Pull Requests (PRs) merge smoothly and keep the codebase pristine.

🔗 Quick Links

👑 Maintainers

🛠 How to Contribute

  1. Verify Your License Scope → Ensure you are working within the bounds of your tier. Community UI changes are welcome from anyone, but core logic modifications require testing via an IRIS PRO License.
  2. Bugs & small fixes → Open a PR directly in the private repository!
  3. New features / architecture → Start a GitHub Discussion or open an Issue first. Please don't spend 20 hours building a massive feature without checking if it aligns with the project roadmap.
  4. Refactor-only PRs → Do not open a PR. Cosmetic refactors (e.g., changing linting rules, reorganizing folders) are not accepted unless requested as part of a specific bug fix.
  5. Questions → Open a Discussion on GitHub.

🛑 Before You PR

  • Test locally with your own API keys in the vault.
  • Ensure both the Main Process (Node.js) and Renderer Process (React) compile without errors:
    • npm run build
  • Mind the Bridge: IRIS operates on a strict split-architecture. Frontend React code cannot use Node.js modules (like fs or child_process). All system-level execution MUST be handled in the protected backend and triggered via the window.electron.ipcRenderer.invoke bridge.
  • Keep PRs focused. One feature/fix per PR. Do not mix unrelated concerns.
  • Include screenshots/videos: If you change the UI (Tailwind/GSAP/Framer Motion), you must include a before/after screenshot or a screen recording of the animation in your PR description.
  • Strict Commit Formatting: Keep your commit messages clean, descriptive, and easy to understand. Clearly state what the commit accomplishes and always include the relevant Issue ID so we can track the changes.

✅ git commit -m "feat: integrated new desktop widget (#45)"
✅ git commit -m "fix: resolved IPC memory leak in Oracle module (#12)"
❌ git commit -m "Integrated desktop widget"
❌ git commit -m "resolved IPC memory leak in Oracle module"

🤖 AI-Assisted PRs Welcome!

Built this with Gemini, Claude, or Cursor? Awesome—just mark it!

Since IRIS is an AI-first desktop assistant, AI-assisted code is treated as a first-class citizen. Transparency is required so the implementation can be reviewed accurately.

Please include in your PR description:

  • Mark as AI-assisted in the PR title or description.
  • Note the degree of testing (untested / lightly tested / fully tested locally).
  • Confirm you actually understand what the generated code does (especially regarding Electron IPC and memory management).
  • Resolve any automated review bot comments before asking for a human review.

🧭 Current Focus & Roadmap

As a solo dev, I am currently prioritizing:

  • Engine Stability: Hardening the BidiGenerateContent WebSocket connection for the multimodal live assistant layer.
  • BYOK Security: Ensuring no edge cases leak keys from the local secure vault.
  • Agentic Tools: Expanding the RAG Oracle and Mobile Automation (ADB) toolsets.
  • Cross-Platform: Preparing the build pipeline for macOS and Linux desktop deployment.

Check the GitHub Issues for labels like good first issue or help wanted.

🤝 Becoming a Core Contributor

IRIS is growing, and I am selectively looking to expand the maintainer team. If you are an elite developer who understands Electron, React, or local LLM execution, and you operate with a valid IRIS PRO License, I'd love to have you on board.

Being a maintainer is about consistent involvement—triaging issues, reviewing PRs, and driving the architecture forward.

If you've successfully merged a few PRs and want to step up, reach out via Instagram DM or open an issue titled [Maintainer Application]. We are looking for people skilled in:

  • Electron Security & IPC
  • Native Desktop Integration (Windows/macOS/Linux desktop APIs)
  • Vector Databases (LanceDB) & RAG pipelines
  • UI/UX Animation (GSAP, WebGL, Framer Motion)

🛡️ Report a Vulnerability

Because IRIS handles direct system-level execution and local vault decryption, security is the highest priority.

If you find a vulnerability that allows for Remote Code Execution (RCE), key leakage, or IPC bridge bypassing, DO NOT open a public issue. Please report it directly via email to: irisaidevop@gmail.com

Required in Security Reports:

  1. Severity Assessment (Low/Medium/High/Critical)
  2. Affected Component (e.g., Main Process, React UI, RAG Oracle)
  3. Technical Reproduction Steps
  4. Demonstrated Impact
  5. Remediation Advice (if you have a suggested fix)