Skip to content

Conversation

@Bullish-Design
Copy link
Owner

Motivation

  • Provide end-user documentation for onboarding and troubleshooting by adding canonical docs for getting started, workspace schema, Claude integration, and troubleshooting.
  • Remove templating-only references from the README and link to the new documentation pages for clarity.
  • Standardize the test layout to separate fast/unit tests from integration tests and fixtures for clearer CI workflows.
  • Add lightweight CI and pre-commit tooling to ensure consistent linting and test execution across contributors.

Description

  • Add documentation files: docs/getting-started.md, docs/workspace-schema.md, docs/claude-integration.md, and docs/troubleshooting.md, and link them from README.md.
  • Reorganize test layout by moving tests into tests/unit, tests/integration, and tests/fixtures, move conftest.py to tests/, and add pytest markers to tests; update pyproject.toml to set testpaths to tests/unit and tests/integration and add markers for unit and integration.
  • Add test runner and convenience scripts by moving the test runner to scripts/run_tests.py (update path resolution to the repo root) and adding scripts/test.sh which runs uv sync --extra dev and uv run pytest.
  • Add CI and pre-commit hooks: .github/workflows/ci.yml to run uv sync/uv run pytest on push/PR, and .pre-commit-config.yaml to run ruff hooks.

Testing

  • No automated tests were executed locally as part of this change.
  • CI is configured to run uv sync --extra dev and uv run pytest via .github/workflows/ci.yml on push and pull_request.
  • Pre-commit hooks are configured and will run uv run pre-commit run --all-files in CI.
  • Test runner script scripts/run_tests.py was updated to point at the new tests/ directory for coverage collection.

Codex Task

@Bullish-Design
Copy link
Owner Author

@copilot Take out the CI tests. I want to handle my CI via another method.

Copy link
Contributor

Copilot AI commented Dec 31, 2025

@Bullish-Design I've opened a new pull request, #32, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot AI and others added 2 commits December 31, 2025 22:47
Remove CI workflow and pre-commit configuration
@Bullish-Design Bullish-Design merged commit 9b0a6dd into nixos Dec 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants