Skip to content

docs: add unit testing instructions to CLAUDE.md #113

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

Merged
merged 1 commit into from
Jul 31, 2025
Merged

docs: add unit testing instructions to CLAUDE.md #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
28 changes: 27 additions & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,34 @@ The project includes type stubs and typing information:
2. Run type checking: `mypy servc --check-untyped-defs`
3. Fix any type issues before committing

## Unit Testing with unittest

### Setup
This project uses Python's built-in unittest framework for testing. The coverage dependency is included in `requirements-dev.txt` for test coverage analysis.

### Required Commands
To enable full unit testing capabilities, Claude needs permission to run:
- `python -m unittest discover tests` - Run all unit tests in the tests directory
- `python -m unittest tests.test_config` - Run specific test module
- `python -m coverage run -m unittest discover tests` - Run tests with coverage analysis
- `python -m coverage report` - Display coverage report
- `python -m coverage html` - Generate HTML coverage report

### Test Structure
The project includes comprehensive unit tests:
- `tests/` directory contains all test files
- Test files follow the `test_*.py` naming convention
- Uses standard unittest.TestCase classes for test organization

### Development Workflow
1. Install development dependencies: `pip install -r requirements-dev.txt`
2. Run all tests: `python -m unittest discover tests`
3. Run tests with coverage: `python -m coverage run -m unittest discover tests`
4. Check coverage report: `python -m coverage report`
5. Fix any failing tests before committing

## Permissions
Claude requires the following Bash tool permissions:
- `pip` commands for dependency installation
- `python` commands for running type checkers
- `python` commands for running type checkers and unit tests
Copy link
Preview

Copilot AI Jul 31, 2025

Choose a reason for hiding this comment

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

[nitpick] This line combines two different purposes (type checking and unit testing) in a single bullet point. Consider splitting this into separate bullet points for clarity: '- python commands for running type checkers' and '- python commands for running unit tests'.

Suggested change
- `python` commands for running type checkers and unit tests
- `python` commands for running type checkers
- `python` commands for running unit tests

Copilot uses AI. Check for mistakes.

- `mypy` commands for static type analysis
Loading