Skip to content

Latest commit

 

History

History
62 lines (43 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

62 lines (43 loc) · 1.54 KB

Contributor Guide

Thank you for your interest in improving litestar-getpaid. This project is open-source under the MIT license and welcomes contributions in the form of bug reports, feature requests, and pull requests.

Resources

How to report a bug

Report bugs on the Issue Tracker.

When filing an issue, include:

  • Operating system and Python version
  • litestar-getpaid version
  • Litestar and SQLAlchemy versions (if relevant)
  • Steps to reproduce
  • Expected vs actual behavior

How to set up your development environment

You need Python 3.12+ and uv.

Clone and install:

git clone https://github.com/django-getpaid/litestar-getpaid.git
cd litestar-getpaid
uv sync

Run tests:

uv run pytest

Run linting:

uv run ruff check src/ tests/
uv run ruff format --check src/ tests/

How to submit changes

  1. Fork the repository and create a feature branch
  2. Write tests for your changes
  3. Ensure all tests pass: uv run pytest
  4. Ensure linting passes: uv run ruff check src/ tests/
  5. Open a pull request

Your pull request needs to:

  • Pass the test suite without errors
  • Include tests for new functionality
  • Update documentation if adding features