Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📘 Documentation: reviewed, corrected, and verified all commands in docs working #7

Merged
merged 2 commits into from
Apr 3, 2025

Conversation

KemingHe
Copy link
Owner

@KemingHe KemingHe commented Apr 3, 2025

No description provided.

KemingHe added 2 commits April 3, 2025 14:09
uniformly using pytest --cov for coverage because project is an app and not a python package. removed redundant docker-design sections because already implemented in cicd automation
@KemingHe KemingHe added the documentation Improvements or additions to documentation label Apr 3, 2025
@KemingHe KemingHe self-assigned this Apr 3, 2025
@Copilot Copilot bot review requested due to automatic review settings April 3, 2025 18:13
@KemingHe KemingHe enabled auto-merge April 3, 2025 18:13
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR focuses on updating documentation commands and metadata while removing outdated content in the Docker design documentation.

  • Updated test commands to simplify coverage configuration in tests and the developer guide.
  • Bumped the project version in pyproject.toml from 1.0.3 to 1.0.4.
  • Removed an obsolete "Future Considerations" section in the Docker design docs.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
tests/README.md Updated the coverage command for running tests.
pyproject.toml Incremented the version to reflect recent updates.
docs/docker-design.md Removed outdated future considerations on container design.
docs/developer-guide.md Updated the coverage command similarly to tests/README.md.

Copy link

codecov bot commented Apr 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (e71d711) to head (85efaef).

Additional details and impacted files
@@            Coverage Diff            @@
##              main        #7   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          203       203           
  Branches         6         6           
=========================================
  Hits           203       203           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@KemingHe KemingHe merged commit 2feaa3f into main Apr 3, 2025
11 checks passed
@KemingHe KemingHe deleted the docs/doc-correction/KemingHe branch April 3, 2025 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant