Skip to content

docs: document dogfooding technique in CONTRIBUTING.md#1791

Merged
nathanjmcdougall merged 3 commits into
mainfrom
copilot/document-dogfooding-technique
Apr 4, 2026
Merged

docs: document dogfooding technique in CONTRIBUTING.md#1791
nathanjmcdougall merged 3 commits into
mainfrom
copilot/document-dogfooding-technique

Conversation

Copilot AI commented Apr 4, 2026

Copy link
Copy Markdown
Contributor

CONTRIBUTING.md had no guidance on how to run usethis against the repo itself during development. This is particularly important on Windows, where using the project's own venv can cause permissions conflicts.

Changes

  • Testing › Dogfooding — new subsection documenting uvx --from . usethis <command> as the recommended way to dogfood CLI changes against the repo itself, explaining why it's preferred over uv run usethis (isolated venv), and including the cleanup commands to revert side-effects afterwards.
uvx --from . usethis <command>
# then revert side-effects:
git checkout -- .
git clean -fd

Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/e9ac6475-ab3e-424b-b1c0-d8a09ee6aaaf

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot AI changed the title [WIP] Document dogfooding technique in CONTRIBUTING.md docs: document dogfooding technique in CONTRIBUTING.md Apr 4, 2026
Copilot AI requested a review from nathanjmcdougall April 4, 2026 00:13
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review April 4, 2026 00:22
@nathanjmcdougall nathanjmcdougall merged commit a098c1e into main Apr 4, 2026
1 check passed
@nathanjmcdougall nathanjmcdougall deleted the copilot/document-dogfooding-technique branch April 4, 2026 00:27
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.

Document dogfooding technique in CONTRIBUTING.md

2 participants