Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.46 KB

File metadata and controls

38 lines (25 loc) · 1.46 KB

Contributing to Offline Markdown Preview

Thank you for your interest in contributing. Pull requests, bug reports, and feature suggestions are welcome.

How to Contribute

  1. Fork the repository
  2. Create a branch for your feature or bug fix
  3. Make your changes with clear, descriptive commit messages
  4. Test your changes (unit tests and/or e2e where relevant)
  5. Update documentation if behaviour or settings changed
  6. Open a pull request against the main branch

Code Guidelines

  • Keep changes focused and easy to review
  • Preserve offline-first and security-focused behaviour
  • Add or update tests for bug fixes and new features when practical
  • Keep user-facing docs/settings descriptions accurate

Reporting Issues

  • Use the issue tracker for bugs and feature requests: TODO: add GitHub issues URL
  • Include reproduction steps, sample Markdown (if relevant), screenshots, and logs/errors
  • Note your VS Code version, OS, and extension version

Security / Safety Notes

  • Please do not post sensitive document contents or private data in public issues
  • If the issue relates to sanitization, CSP, or link-handling safety, include a minimal reproducible example

Code of Conduct

Be respectful and inclusive. We follow the Contributor Covenant Code of Conduct.

Questions?

Open an issue (TODO: add repository URL) and include context on what you are trying to do.