Skip to content

Commit

Permalink
docs: ✏️ Add tips on testing to developer docs
Browse files Browse the repository at this point in the history
Inform how to run copier with a dirty state.
  • Loading branch information
abelsiqueira committed May 14, 2024
1 parent b5496df commit 10625d5
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/src/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit 10625d5

Please sign in to comment.