Skip to content

Repository navigation

CONTRIBUTING.md

Latest commit

 

History

History
77 lines (51 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

77 lines (51 loc) · 2.69 KB
Raw

Contributing to PyStormTracker

Thank you for your interest in contributing to PyStormTracker! We welcome contributions from the community to help improve this cyclone tracking framework.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue on GitHub. Include:

  • A clear description of the issue.
  • Steps to reproduce the bug.
  • Any relevant logs or error messages.
  • Information about your environment (OS, Python version, PyStormTracker version).

Suggesting Enhancements

We welcome ideas for new features or improvements. Please open an issue to discuss your proposal before starting implementation.

Submitting Pull Requests

  1. Fork the repository and create your branch from main.

  2. Install development dependencies:

    uv sync

  3. Make your changes:

    • Ensure your code follows the project's style (use ruff for formatting and linting).
    • Add or update tests for your changes.
    • Ensure all tests pass.

  4. Run the local quality checks:

    uv run prek run --all-files
uv run mypy
uv run pytest
uv run pytest tests/integration -m "not slow and not data"
uv run pytest tests/parity -m "not slow and not data"
uv run python scripts/generate_trackjson_schema.py --check

    uv run pytest is the fast unit suite because the default test paths are tests/unit. See the testing guide for external-data and expensive validation.

  5. Submit the Pull Request:

    • Provide a clear description of the changes.
    • Reference any related issues.

Development Standards

  • Code Style: We use ruff for linting and formatting.
  • Type Safety: All new code should be type-hinted and pass mypy strict checks.
  • Testing: We use pytest. Unit tests run with uv run pytest; select integration or parity explicitly with their directory and use -m slow for expensive cases. See docs/development/testing.md for the standard commands.
  • Documentation: Update the documentation in docs/ if you introduce new features or change existing behavior.

Governance

This project is currently maintained by Albert M. W. Yau. Decisions regarding pull requests and the project's roadmap are made by the maintainer in consultation with the community.

Support

For usage questions, configuration help, or unexpected scientific behavior, open a GitHub issue with the PyStormTracker version, platform, and a minimal example where possible.

Conduct

Please be respectful and professional in all interactions within the PyStormTracker community.