docs(project): update documentation and project config

jonathan-irvin · claude · jonathan-irvin · commit ea748b54c12b · 2025-03-02T14:48:05.000-06:00
Update CLAUDE.md with new project structure, commands and git workflow guidelines. Update pyproject.toml with test configuration and better project metadata. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -5,9 +5,18 @@
 # Install dependencies
 poetry install
 
-# Run application
+# Run application (old monolithic structure)
 poetry run python main.py
 
+# Run application (new modular structure)
+poetry run python app.py
+
+# Run tests
+poetry run pytest
+
+# Run tests with coverage
+poetry run pytest --cov=src --cov-report=html
+
 # Build Docker container
 docker build -t bingo .
 
@@ -29,7 +38,73 @@ cd helm && ./package.sh && helm install bingo ./bingo
 - **Comments**: Use docstrings for functions and descriptive comments
 
 ## Project Structure
-- `main.py`: Core application with NiceGUI implementation
+- `app.py`: Main entry point for modular application
+- `src/`: Source code directory
+  - `config/`: Configuration and constants
+  - `core/`: Core game logic
+  - `ui/`: User interface components
+  - `utils/`: Utility functions
 - `phrases.txt`: Contains customizable bingo phrases
 - `static/`: Static assets for fonts and styles
-- `helm/`: Kubernetes deployment configuration
+- `tests/`: Unit and integration tests
+- `helm/`: Kubernetes deployment configuration
+
+## Git Workflow
+
+### Branch Naming
+- Use feature branches for each change: `feature/description-of-change`
+- Use bugfix branches for bug fixes: `fix/description-of-bug`
+- Use chore branches for maintenance: `chore/description-of-task`
+
+### Commit Guidelines
+Follow conventional changelog format:
+
+```
+<type>(<scope>): <subject>
+
+<body>
+
+<footer>
+```
+
+1. **Types**:
+   - `feat`: A new feature
+   - `fix`: A bug fix
+   - `docs`: Documentation only changes
+   - `style`: Changes that do not affect meaning (white-space, formatting)
+   - `refactor`: Code change that neither fixes a bug nor adds a feature
+   - `perf`: Change that improves performance
+   - `test`: Adding missing tests or correcting existing tests
+   - `chore`: Changes to the build process or auxiliary tools
+
+2. **Scope** (optional): The module/component affected, e.g., `core`, `ui`, `board`
+
+3. **Subject**: Short description in imperative, present tense (not past tense)
+   - Good: "add feature X" (not "added feature X")
+   - Use lowercase
+   - No period at the end
+
+4. **Body** (optional): Detailed explanation of changes
+   - Use present tense
+   - Include motivation and context
+   - Explain "what" and "why" (not "how")
+
+5. **Footer** (optional): Reference issues, PRs, breaking changes
+
+### Example Commits:
+```
+feat(board): add color theme selector 
+
+Add ability for users to choose color themes for the bingo board
+
+Resolves #123
+```
+
+```
+fix(ui): resolve client disconnection issues
+
+Handle race conditions during client disconnects to prevent 
+server exceptions and ensure smooth reconnection
+
+Fixes #456
+```
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "bingo"
 version = "0.1.0"
-description = ""
+description = "A bingo board generator using NiceGUI"
 authors = ["Offending Commit <offendingcommit@gmail.com>"]
 license = "MIT"
 readme = "README.md"
@@ -12,7 +12,17 @@ exclude = [".git", ".git/"]
 python = "^3.12"
 nicegui = "^2.11.0"
 
+[tool.poetry.group.dev.dependencies]
+pytest = "^7.4.0"
+pytest-cov = "^4.1.0"
 
 [build-system]
 requires = ["poetry-core>=1.8"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = "test_*.py"
+python_classes = "Test*"
+python_functions = "test_*"
+addopts = "--cov=src"
