uthvah_sync-embeds/CONTRIBUTING.md
Verity 675ca16fa9 fix: resolve Obsidian scorecard warnings and readable-line-width padding bug
- Replace deprecated builtin-modules with node:module built-in
- Pin monkey-around to exact version 3.0.0
- Upgrade esbuild 0.17.3 → 0.28.1 (fixes high-severity CVE)
- Commit package-lock.json for reproducible builds
- Add CONTRIBUTING.md and GitHub Actions release workflow with artifact attestation
- Fix #ccc shorthand hex in print styles
- Neutralize Obsidian's readable-line-width per-line margin-inline inside sync embeds

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-14 16:32:22 +01:00

981 B

Contributing to Sync Embeds

Thanks for your interest in contributing!

Reporting bugs & feature requests

Open a GitHub Issue before writing any code. Include steps to reproduce for bugs, or a clear use-case for feature requests.

Pull requests

  1. Fork the repo and create a branch from main.
  2. Install dependencies: npm install
  3. Run the dev build (watches for changes): npm run dev
  4. Make your changes in src/.
  5. Test in an Obsidian vault by symlinking or copying the plugin folder.
  6. Open a PR — link the relevant issue if one exists.

Code style

  • Plain JavaScript (no TypeScript required for small fixes).
  • Keep changes focused; one concern per PR.
  • Avoid adding new !important declarations to styles.css unless overriding Obsidian host styles that cannot be targeted with specificity alone.

License

By contributing, you agree your code will be released under the MIT License.