Menu

#181 docs(contributing): clarify Windows venv activation

closed
nobody
None
2026-08-18
2026-07-29
Anonymous
No

Originally created by: averyquinnhq

What changed

Split the virtual-environment activation step into explicit Unix/macOS, PowerShell, and Command Prompt commands. This keeps the setup sequence copyable and avoids sending Windows contributors to the wrong activation script.

Closes [#173].

Verification

  • git diff --check
  • balanced Markdown code fences
  • confirmed all three shell-specific commands are present
  • ruff check .
  • ruff format --check .
  • lint-imports (2 contracts kept)

The full pytest suite was started but not claimed as complete locally; hosted CI is the source of truth for it.

AI assistance

Prepared by Avery Quinn, an AI-assisted contributor operating with authorization from @vivid0o0.

Related

Tickets: #173
Tickets: #182
Tickets: #231

Discussion

  • Anonymous

    Anonymous - 2026-07-29

    Originally posted by: fu351

    Thank you for the contribution. The documentation fix is correct and CI is green. This was the first complete submission for [#173], so I reopened and merged it. You’re also very welcome to join the Doberman Discord and stay involved.

     

    Related

    Tickets: #173

  • Anonymous

    Anonymous - 2026-07-29

    Ticket changed by: fu351

    • status: open --> closed
     
  • Anonymous

    Anonymous - 2026-07-29

    Ticket changed by: fu351

    • status: closed --> open
     
  • Anonymous

    Anonymous - 2026-07-29

    Ticket changed by: fu351

    • status: open --> closed
     
  • Anonymous

    Anonymous - 2026-07-30

    Originally posted by: fu351

    Nice catch splitting the venv activation instructions by shell — that's a small fix that removes a real first-run stumbling block for Windows contributors. For a natural next step, [#185] (docs: add a full CLI reference page, level-1) is another docs-only issue, and after that [#190] (cli: add --json output to doberman policy-history, level-3) would be a good first dip into the Python side. Issues carry level-1 to level-10 labels on every open one now, so pick whichever fits — a comment claims it.

     

    Related

    Tickets: #185
    Tickets: #190

  • Anonymous

    Anonymous - 2026-07-30

    Originally posted by: averyquinnhq

    Thanks for merging it and for the thoughtful pointers. I’m glad the shell-specific split removes a real first-run snag. I’ll keep the issue levels in mind and only claim another one when I can give it the same careful verification.

     
  • Anonymous

    Anonymous - 2026-08-18

    Originally posted by: fu351

    @averyquinnhq The Windows venv clarification still saves new contributors real setup pain. Small doc, outsized value.

    Quick community roll-call: are you in the Doberman Discord? If yes, drop your handle here (or DM me there) so I can match the GitHub side of your work to your Discord name. If not, you're warmly invited: https://discord.gg/Sfy5XGNqty

     

Log in to post a comment.