Skip to content

Enhance documentation, CI workflows, and packaging structure - #1

Merged
BeckettFrey merged 23 commits into
mainfrom
release
Mar 11, 2026
Merged

BeckettFrey merged 23 commits into
mainfrom
release

Conversation

@BeckettFrey

Copy link
Copy Markdown
Member

This pull request introduces foundational infrastructure and documentation improvements for the project, focusing on developer experience, CI/CD automation, and clear contribution guidelines. The most significant changes include the addition of continuous integration and deployment workflows, a comprehensive contributing guide, and improved documentation for both users and contributors.

CI/CD Automation and Developer Tooling:

  • Added GitHub Actions workflows for continuous integration (ci.yml) and automated PyPI publishing (cd.yml). The CI workflow enforces type checking, testing, and documentation builds, while the CD workflow publishes releases to PyPI on tag publish events. [1] [2]
  • Introduced a Makefile with common developer commands for building docs, running tests, and type checking, streamlining local development.

Documentation and Contribution Guidelines:

  • Added a detailed contributing guide (.github/CONTRIBUTING.md) covering how to implement, document, and test new plot functions, with a checklist to ensure consistency and quality.
  • Updated the main README.md and added README_PYPI.md to clarify installation, quickstart usage, development workflow, and project badges, improving accessibility for both users and contributors. [1] [2] [3]

API and User Documentation:

  • Added API documentation pages for each plot function (docs/api/phoneme_counts.md, docs/api/phoneme_overlap.md, docs/api/phoneme_overlap_rate.md, docs/api/phoneme_pair_scatter.md), including usage examples and parameter explanations. [1] [2] [3] [4]
  • Introduced a shared parameters reference (docs/api/shared.md) and a CI/CD documentation page (docs/devops/ci-cd.md) to clarify the development and release process for contributors. [1] [2]

Licensing:

  • Added an MIT license to the repository, establishing clear terms for use and contribution.

@BeckettFrey
BeckettFrey merged commit 98ec623 into main Mar 11, 2026
12 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