Skip to content

Latest commit

 

History

History
44 lines (33 loc) · 1.6 KB

File metadata and controls

44 lines (33 loc) · 1.6 KB

Contributing to MetaEdit

Thanks for wanting to contribute to MetaEdit. The best way to start is to use the plugin, get familiar with how people use it, and look through existing issues or discussions for something concrete to improve.

If you already know what you want to change, open a focused pull request with a clear explanation of the problem, the fix, and how you validated it. If you are not sure whether an idea fits the project, please ask first by opening an issue or starting a discussion.

AI-assisted contributions are welcome, but please review the result yourself before submitting it. Do not send maintainers code you have not read. At a minimum, validate that the change works on your machine and include evidence in the pull request, such as the commands you ran, the Obsidian version or dev vault flow you used, and any relevant screenshots for UI changes.

Development

MetaEdit uses pnpm for local development tasks.

pnpm run lint
pnpm run test
pnpm run build

For changes that affect the plugin at runtime, verify the behavior in Obsidian as well as with automated tests. The repo ships an isolated Obsidian E2E harness that provisions a throwaway vault and drives the real app via the obsidian CLI; see AGENTS.md for the full workflow. The quickest check is:

pnpm run obsidian:e2e -- eval code='Boolean(app.plugins.plugins.metaedit)'

Or, against a shared dev vault:

obsidian vault=dev plugin:reload id=metaedit

Keep pull requests narrow. main.js is generated and attached to releases rather than committed; commit styles.css when your change updates it.