CONTRIBUTING.md

Contributing

Thanks for contributing to OpenMarkdown.

Development Setup

npm install
cargo check
npm run dev

Desktop app:

npm run tauri:dev

Branching

• Feature branches: feature/<topic>
• Fix branches: fix/<topic>
• Release branches: release/<version>

Pull Request Rules

• Keep PRs focused.
• Include test/verification notes.
• Update docs for any user-facing behavior change.
• For performance-sensitive changes, include before/after numbers when possible.

Commit Convention

Use:

• feat: ...
• fix: ...
• perf: ...
• docs: ...
• chore: ...

Code Quality

• Rust: cargo check
• Frontend: npm run build

Security

If you discover a security issue, follow SECURITY.md.