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

docs: Update tests/README-DEV.md with developer usage details #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

devloai[bot]
Copy link
Contributor

@devloai devloai bot commented Dec 22, 2024

Resolves #24

This PR updates the developer documentation with comprehensive instructions for:

  1. Local testing
  2. Running the built poetry executable

Changes made:

  1. Updated tests/README-DEV.md with testing instructions:

    • Basic test command: pytest .
    • Running specific test files
    • Verbose output options
    • Coverage reporting
  2. Added instructions for running the built poetry executable:

    • Installation from wheel file
    • Running through poetry directly
    • Using poetry shell
  3. Development environment improvements:

    • Added missing dependencies to pyproject.toml
    • Fixed poetry configuration format
    • Updated poetry.lock file

Verification:

  • All documented commands were tested and work as expected
  • Existing unit tests pass successfully
  • Package builds and runs correctly using both documented methods

- Add local testing instructions
- Add instructions for running built poetry executable
- Update dependencies in pyproject.toml
- Update poetry.lock file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update tests/README-DEV.md with Developer Usage Details
0 participants