Repository navigation
Enhance documentation, CI workflows, and packaging structure - #1
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
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]Makefilewith common developer commands for building docs, running tests, and type checking, streamlining local development.Documentation and Contribution Guidelines:
.github/CONTRIBUTING.md) covering how to implement, document, and test new plot functions, with a checklist to ensure consistency and quality.README.mdand addedREADME_PYPI.mdto clarify installation, quickstart usage, development workflow, and project badges, improving accessibility for both users and contributors. [1] [2] [3]API and User Documentation:
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]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: