Skip to content

Contributing

Contributions are welcome! To contribute, please follow these steps:

  1. Fork the repository on GitHub: https://github.com/basnijholt/markdown-code-runner
  2. Create a new branch for your changes.
  3. Make your changes, ensuring that they adhere to the code style and guidelines.
  4. Submit a pull request with a description of your changes.

Please report any issues or bugs on the GitHub issue tracker: https://github.com/basnijholt/markdown-code-runner/issues

Thank you for your interest in markdown-code-runner!

Development Setup

  1. Clone the repository:
git clone https://github.com/basnijholt/markdown-code-runner.git
cd markdown-code-runner
  1. Create a virtual environment and install dependencies:
# Using uv (recommended)
uv sync

# Or using pip
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -e ".[test]"
  1. Run the tests:
pytest
  1. Run pre-commit hooks:
pre-commit run --all-files

Code Style

This project uses:

  • Ruff for linting and formatting
  • MyPy for type checking
  • pytest for testing with 100% code coverage requirement

Pull Request Process

  1. Create a new branch for your changes
  2. Make your changes and add tests
  3. Ensure all tests pass: pytest
  4. Ensure pre-commit passes: pre-commit run --all-files
  5. Submit a pull request with a clear description

Reporting Issues

Please report issues on the GitHub issue tracker.

Include:

  • A clear description of the problem
  • Steps to reproduce
  • Expected vs actual behavior
  • Your Python version and OS