From 10625d54e4c18d2113d64b9d2d87285e9df06b1b Mon Sep 17 00:00:00 2001 From: Abel Soares Siqueira Date: Tue, 14 May 2024 10:30:25 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Add=20tips=20on=20?= =?UTF-8?q?testing=20to=20developer=20docs?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Inform how to run copier with a dirty state. --- docs/src/developer.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/src/developer.md b/docs/src/developer.md index 3fc2939e..37f9d2a9 100644 --- a/docs/src/developer.md +++ b/docs/src/developer.md @@ -93,3 +93,15 @@ If this is the first time you work with this repository, follow the instructions ``` - Then you can open a pull request and work with the reviewer to address any issues. + +## Tips + +### Testing local changes + +To test you local modifications, you can run copier with the `--vcs-ref HEAD` flag and point to your local clone. This will use the latest changes, including uncommitted modifications (i.e., the dirty state). +What I normally do is this: + +```bash +cd $(mktemp -d) # Go to a tmp folder +copier copy --vcs-ref HEAD /path/to/clone/ pkg # Clone dirty clone into pkg +```