Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (48 loc) · 1.47 KB

CONTRIBUTING.md

File metadata and controls

67 lines (48 loc) · 1.47 KB

Contributing to prefetch2es

Thank you for your interest in contributing to prefetch2es!

Getting Started

Development Setup

Recommended: Using Dev Container

This project includes a dev container configuration for consistent development environment:

  1. Fork the repository on GitHub
  2. Clone your fork locally:
$ git clone https://github.com/your-username/prefetch2es.git
$ cd prefetch2es
  1. Open in VS Code with Dev Container extension, or use the provided dev container

Alternative: Local Setup

$ pip install uv
$ uv sync --dev

Editor: This project is developed using Cursor with custom rules (currently being organized).

Running Tests

$ uv run pytest

Code Style

This project uses:

  • black for code formatting
  • flake8 for linting
  • mypy for type checking

Contributing

Reporting Issues

  • Use GitHub Issues to report bugs or request features

Pull Requests

  1. Create a feature branch from master
  2. Make your changes
  3. Add tests if applicable
  4. Ensure all tests pass
  5. Submit a pull request

Guidelines

  • Follow existing code style and patterns
  • Update documentation if needed

Requirements

  • Python 3.11+
  • Dependencies listed in pyproject.toml

License

By contributing, you agree that your contributions will be licensed under the LGPLv3+ License.

Questions?

Feel free to open an issue for discussion or reach out to the maintainers.

Thank you for contributing! 🍣 🍣 🍣