chore: Improve documentation, test coverage and CI workflow#27
Merged
chore: Improve documentation, test coverage and CI workflow#27
Conversation
Owner
Author
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
isakruas
force-pushed
the
chore/improve-docs-tests-and-ci
branch
3 times, most recently
from
43e1476 to
04a1339
Compare
- Add benchmarks, security and configuration documentation pages - Reorganize docs structure with mkdocstrings for API reference - Achieve 100% test coverage with edge case tests - Consolidate CI workflows into single ci.yml - Add ruff for linting and formatting - Add benchmark scripts for performance testing - Update README with performance data and supported curves - Update CHANGELOG for v1.1.5 Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
isakruas
force-pushed
the
chore/improve-docs-tests-and-ci
branch
from
04a1339 to
8d65667
Compare
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. Thanks for integrating Codecov - We've got you covered ☂️ |
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
2 participants
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.
Summary
This PR improves the overall project quality with enhanced documentation, 100% test coverage, and streamlined CI/CD pipeline. Claude AI assisted in optimizing tests and documentation structure.
Added
benchmarks.py,benchmarks_helper.py)Changed
ci.ymlRemoved
reference/structure)codecov.yml,pypi.yml)Test plan
pytest --cov=ecutils tests/)mkdocs build --strict)ruff check src/ecutils/)