Skip to content

Improve open source readiness - #16

Merged
morehardy merged 3 commits into
mainfrom
codex/open-source-readiness
May 26, 2026
Merged

Improve open source readiness#16
morehardy merged 3 commits into
mainfrom
codex/open-source-readiness

Conversation

@morehardy

Copy link
Copy Markdown
Owner

Summary

  • Add MIT licensing, community docs, security/conduct policies, roadmap, changelog, and GitHub issue templates.
  • Improve README discoverability with badges, canonical repository links, license status, and community entry points.
  • Add PyPI discovery metadata and tests for keywords, classifiers, license, and project URLs.

Test Plan

  • PYTHONPATH=src uv run --python 3.14 python -m unittest discover -s tests -p 'test_*.py'
  • uv build
  • uv run --python 3.14 --with twine python -m twine check dist/echoalign_asr_mlx-0.5.1.dev0+gb77713fee.d20260526*
  • External implementation audit: Approved

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds comprehensive community and project health files, including a contributing guide, code of conduct, security policy, roadmap, changelog, and GitHub issue templates. It also updates PyPI package metadata in pyproject.toml and adds a test to verify these metadata fields. Feedback on the test suite points out that resolving pyproject.toml using a relative path from the current working directory can cause FileNotFoundError if tests are run from a different directory, and suggests resolving the path relative to the test file's location instead.

Comment thread tests/test_package.py Outdated
self.assertIn("torchcodec>=0.11.1", mlx_dependencies)

def test_package_metadata_includes_discovery_fields(self) -> None:
pyproject = tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Using Path("pyproject.toml") assumes that the current working directory of the test runner is always the repository root. If the tests are executed from another directory (e.g., from within the tests directory), this will raise a FileNotFoundError. It is more robust to resolve the path relative to the test file's location using __file__.

Suggested change
pyproject = tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))
pyproject = tomllib.loads((Path(__file__).parent.parent / "pyproject.toml").read_text(encoding="utf-8"))

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 8b5205b. tests/test_package.py now resolves pyproject.toml relative to the test file via Path(__file__).resolve().parents[1], and both metadata tests use the shared helper. Verified from the repo root and from the tests/ directory.

@morehardy
morehardy merged commit b672159 into main May 26, 2026
2 checks passed
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