Skip to content

add 'coverage' dev-dependency and update CONTRIBUTING.md #9

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.

Sign up for GitHub

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

add 'coverage' dev-dependency and update CONTRIBUTING.md #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
051a88a
add 'coverage' dev-dependency and update CONTRIBUTING.md
Dec 8, 2024
6ecd330
Merge branch 'main' into stgum/coverage
corinagum Dec 9, 2024
4c8da31
Merge branch 'main' into stgum/coverage
corinagum Dec 10, 2024
b068850
Merge branch 'main' into stgum/coverage
corinagum Dec 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions .github/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,16 @@ provided by the bot. You will only need to do this once across all repos using o
## Quick start

1. Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
2. `uv sync` - it installs the virtual env and dependencies
3. Activate virtual env - `source .venv/bin/activate` _(for Windows it is `.venv\Scripts\Activate`)_
1. `uv sync` - it installs the virtual env and dependencies
1. Activate virtual env - `source .venv/bin/activate` _(for Windows it is `.venv\Scripts\Activate`)_

## Code coverage report

**Note:** You must have completed the [Quick start](#quick-start) to generate the code coverage report.

1. Navigate to the root level of the repository
1. Run `coverage run -m pytest && coverage html` to generate the coverage report in html format in the `htmlcov/` folder
1. Open `htmlcov/index.html` to review the code coverage in your browser

## See related

Expand Down
9 changes: 9 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ dependencies = ["agent-runtime", "memory-module", "litellm"]
[tool.uv]
package = false
dev-dependencies = [
"coverage>=7.6.9",
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know if coverage details are that important at this stage of the project. But feel free to include it and have it run as a github action.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree with your point, but I think it's a good for two scenarios:

  1. setting up a quality bar for the team to enforce later on (I say later on because it's important for the team to move quickly now)
  2. people who aren't part of the core team can contribute via tests and learn the codebase

Copy link
Contributor

@heyitsaamir heyitsaamir Jan 13, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Hey @stevengum, if you still have bandwidth, could you rebase this? We'd love to merge this in

"poethepoet>=0.28.0",
"pre-commit>=4.0.1",
"pytest-asyncio>=0.24.0",
Expand All @@ -25,6 +26,14 @@ memory-module = { workspace = true }
[tool.uv.workspace]
members = ["packages/*"]

[tool.coverage.run]
omit = [
# omit the Basic AI Chatbot template
"*/src/*",
# omit the tests from the coverage report
"*/tests/*"
]

[tool.ruff]
line-length = 120
fix = true
Expand Down
40 changes: 40 additions & 0 deletions uv.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading