Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
50 lines (33 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

50 lines (33 loc) · 1.55 KB
Raw

Contributing to MRMS Renderer

Thanks for your interest in MRMS Renderer.

MRMS Renderer is focused on retrieving, rendering, and visualizing NOAA MRMS radar data locally. Contributions that improve correctness, performance, portability, documentation, testing, visualization quality, or developer experience are welcome.

Before contributing

Please keep contributions focused on the functionality and public interfaces documented in this repository. Proprietary Taylor Creative Development products, services, and infrastructure are outside the scope of this project.

Development setup

The intended development workflow is:

python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e '.[dev]'

Pull requests

Please keep pull requests focused and explain:

  • what problem the change solves;
  • how the change was tested;
  • whether radar output, geographic behavior, dependencies, or public interfaces change.

For rendering changes, include before/after examples when practical.

Generated data

Do not commit downloaded MRMS GRIB2 files, generated radar frames, or other large runtime artifacts. The repository's .gitignore excludes these outputs.

NOAA and third-party data

Contributions must respect NOAA data attribution and the attribution/license requirements of any map or third-party resources used by the demo.

Prior art and copied code

MRMS Renderer is independently implemented. Do not copy code from projects with incompatible or additional licensing obligations into this repository without explicit discussion and approval.