Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: ✏️ Add tips on testing to developer docs #71

Merged
merged 1 commit into from
May 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
```
Loading