Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.76 KB

Contributing to MythosIDE

Thanks for your interest in contributing! MythosIDE is early-stage and maintained by a small team, so a bit of process up front saves everyone time.

Before you write code

  • Bug fixes and small improvements — feel free to open a PR directly.
  • New features or architectural changes — please open an issue or start a Discussion first. Some areas (core file format, indexing engine, the boundary between the free core and Pro features) are intentionally conservative about outside changes; checking first avoids wasted work on either side.
  • Check existing issues and Discussions before starting, to avoid duplicate effort.

Development setup

Detailed local setup instructions will be added here as the project stabilizes (Tauri + Node.js toolchain requirements, running the dev build, running tests).

Pull request guidelines

  • Keep PRs focused — one logical change per PR is easier to review than a bundle of unrelated fixes.
  • Add or update tests where it makes sense for the change.
  • Describe why the change is needed, not just what changed.
  • Be patient — this is a small team, review may take a few days.

Contributor License Agreement

We may introduce a lightweight CLA before merging external contributions, to keep licensing (see LICENSE.md) unambiguous for everyone. If so, this section will be updated with the process.

Code of conduct

Be respectful and constructive. Disagreements about technical direction are fine and expected; personal attacks, harassment, or bad-faith arguing are not, and may result in removal from the project's spaces.

Questions

Open a Discussion — general questions don't need to be issues.