Skip to content

Modifying package so we can start publishing project.#97

Draft
andrewfayres wants to merge 1 commit intomainfrom
apeiron-package-restructure
Draft

Modifying package so we can start publishing project.#97
andrewfayres wants to merge 1 commit intomainfrom
apeiron-package-restructure

Conversation

@andrewfayres
Copy link
Copy Markdown
Collaborator

Summary

Motivation & Context

E.g. Fixes issue nr xyz

Approach

Screenshots / Logs (optional)

API / CLI Changes

  • foo.bar(x: int) -> str (new)
  • baz(qux: PathLike) (removed strict: bool)

Breaking Changes

  • None

Performance (optional)

Case Before After Notes
foo() 123 ms 88 ms Median of 50 runs

Security & Privacy

  • No secrets committed
  • Input validation added where needed

Dependencies

  • Added: orjson>=3.10
  • Removed: ujson

Testing Plan

  • Unit tests
  • Integration tests
  • e2e / smoke test
  • Manual steps: python -m app --help

Documentation

  • Docstrings updated
  • User docs / README updated
  • CHANGELOG entry

Checklist

  • Code formatted (Ruff) → ruff format --check
  • Lint passes (Ruff) → ruff check .
  • Types pass (mypy/pyright) → mypy src
  • Tests pass (pytest) → pytest -q
  • Backward compatibility considered
  • Adequate comments for tricky parts
  • CI green

Risk & Rollback Plan

Probably not needed in the beginning

Notes for Reviewers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant