Skip to content

Commit

Permalink
fix: begin to create development instruction
Browse files Browse the repository at this point in the history
fix: update contributing
  • Loading branch information
lwasser committed Feb 28, 2025
1 parent 375b29e commit 471236b
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# Contributing to the pyOpenSci Python package template

To work on the template locally, you can call the copier template using:
To work on the template locally, you can call the copier template directly. Note that by default, `copier` uses the latest tag in your commit history. To ensure it uses the latest commit on your current active branch use:

`copier copy /path/to/your/template destination-folder`
`copier copy -r HEAD /path/to/your/template destination-dir`

If you want to test it against the latest tag in your local commit history, you can use:

`copier copy /path/to/your/template destination-dir`

## Run the tests

You can use Hatch to run all of the tests for the template:

`hatch run test:run`

0 comments on commit 471236b

Please sign in to comment.