Skip to content

Latest commit

 

History

History
27 lines (17 loc) · 1.11 KB

File metadata and controls

27 lines (17 loc) · 1.11 KB

Contributing to markdown-magic-transform-badges

Thank you for your interest in contributing! We welcome bug reports, feature requests, and pull requests.

How to raise issues

  • Open an issue on the repository with a clear title and description.
  • Provide steps to reproduce (if applicable), expected vs actual behavior, and environment details.
  • Tag the issue appropriately (bug, enhancement, question).

How to contribute code

  1. Fork the repository and create a feature branch named descriptively (e.g., feat/add-option or fix/help-bug).
  2. Run tests locally and ensure they pass: npm test.
  3. Make your changes, add tests if applicable, and ensure linting and tests pass.
  4. Submit a pull request against main with a clear description of your changes and why they're needed.

Code style and tests

  • Follow existing code style; keep changes small and focused.
  • Add tests for bug fixes and new features.

Communication

  • For design discussions or broader changes, please open an issue before heavy work so we can agree on the approach.

Thank you for contributing — your help makes this project better!