Menu

#177 docs: add a targeted-test selection guide for contributors

closed
nobody
2026-07-30
2026-07-29
Anonymous
No

Originally created by: fu351
Originally owned by: navaneethsankar07

Context

The contributor guide lists project-wide verification commands, but a new contributor may not know which focused tests to run while iterating on a small change. A concise mapping from common change areas to existing test paths would make the feedback loop faster without weakening the final quality gate.

Suggested starting point

  • CONTRIBUTING.md (github.com)
  • Existing test directories under tests/
  • pyproject.toml for the authoritative pytest and coverage configuration

Acceptance criteria

  • [ ] Add a “choosing targeted tests” section to CONTRIBUTING.md.
  • [ ] Explain the difference between focused iteration tests and the full pre-PR verification suite.
  • [ ] Map several common areas (CLI, policy/engine rules, storage/logging, proxy/host hooks, and docs-only changes where applicable) to real test files or directories.
  • [ ] Include copyable pytest examples for one file, one test, and a keyword selection.
  • [ ] State that contributors still need to run the repository's complete lint, import-boundary, and test/coverage checks before marking a PR ready.
  • [ ] Verify every referenced command and path exists in the current repository.
  • [ ] Keep Windows and Unix shell differences in mind; avoid shell-specific syntax when a portable command works.

Suggested validation

Copy each documented command into a development environment and confirm pytest collects the intended tests. Preview the rendered Markdown.

Out of scope

  • Changing CI, pytest configuration, or the coverage threshold.
  • Removing or weakening any required verification command.
  • Creating new test suites solely to support the guide.

Security and compatibility

The guide must preserve the standalone-core and import-boundary checks. Do not suggest skipping security tests or using real credentials, network services, or user runtime data.

See CONTRIBUTING.md (github.com) before opening a pull request.

Related

Tickets: #216

Discussion

  • Anonymous

    Anonymous - 2026-07-29

    Originally posted by: navaneethsankar07

    Hi! I'd like to work on this issue.

     
  • Anonymous

    Anonymous - 2026-07-29
     
  • Anonymous

    Anonymous - 2026-07-29

    Originally posted by: fu351

    Go ahead! I've assigned you to the issue. Welcome to Doberman! Looking forward to working with you in the future.
    Feel free to star the Repo and join the discord if you have any questions.

     
  • Anonymous

    Anonymous - 2026-07-30

    Ticket changed by: fu351

    • status: open --> closed
     

Log in to post a comment.