SONARIS / .github /pull_request_template.md
deringeorge's picture
docs: add PR template, CI workflow, architecture docs, research log, and module docstrings
d901d8e

A newer version of the Streamlit SDK is available: 1.55.0

Upgrade

Description

Closes #


PR Type

  • Bug fix
  • New feature
  • Data contribution (URN database)
  • Documentation update
  • Model / algorithm improvement
  • Performance improvement
  • Tests
  • Other (describe below)

Modules Affected

  • Module 1 β€” Design Input Engine
  • Module 2 β€” URN Prediction Core
  • Module 3 β€” IMO Compliance Checker
  • Module 4 β€” Marine Bioacoustic Impact Module
  • Module 5 β€” Mitigation Recommendation Engine
  • Module 6 β€” Open URN Database
  • General / Infrastructure

Scientific Basis

N/A


Testing

# pytest output here

Screenshots / Output


Pre-Merge Checklist

  • Code follows PEP 8 and all new functions include type hints
  • All new functions have docstrings (Google-style)
  • pytest passes locally with no new failures
  • No raw data files, .pt model weights, or .env files are included
  • CHANGELOG.md updated under [Unreleased] with a summary of changes
  • If any module algorithm or methodology was changed, a scientific reference or technical justification is provided in the Scientific Basis section above