obsidian-plugin/rmoff_obsidian-canvas-export

mirror of https://github.com/rmoff/obsidian-canvas-export.git synced 2026-07-22 14:00:23 +00:00

rmoff 6939dedc19 Add CONTRIBUTING.md and bump to 1.0.2

Adds a short contributing guide (build, lint, issues, PRs, release
process) so the scorecard's "Missing contributing guide" item is
resolved, and bumps `manifest.json` / `versions.json` to 1.0.2 for
the release that ships the scorecard fixes.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

2026-05-14 10:46:02 +01:00

1.4 KiB

Raw Permalink Blame History

Contributing

Thanks for your interest in Canvas Export. Bug reports, feature requests and pull requests are all welcome.

Reporting issues

Open an issue at https://github.com/rmoff/obsidian-canvas-export/issues.
Include your Obsidian version, OS, the steps to reproduce, and (if relevant) a small .canvas file that triggers the problem.

Development setup

You will need Node.js 18+ and npm.

git clone https://github.com/rmoff/obsidian-canvas-export.git
cd obsidian-canvas-export
npm install

Useful scripts:

npm run dev — esbuild in watch mode.
npm run build — production build (writes main.js).
npm run lint — runs eslint-plugin-obsidianmd (the same checks the Obsidian community-plugin reviewer uses).

To test in Obsidian, symlink or copy main.js, manifest.json and styles.css into a vault's .obsidian/plugins/canvas-export/ folder and enable the plugin.

Pull requests

Run npm run lint and npm run build before opening a PR; both should be clean.
Keep changes focused — one PR per logical change.
For UI-visible changes, please describe what you tested manually in the PR body.

Releases

Releases follow semver. Maintainers cut releases by bumping the version in manifest.json, package.json and versions.json, then creating a GitHub release whose tag matches the version (no v prefix) and which attaches main.js, manifest.json and styles.css.