-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: begin to create development instruction
fix: update contributing
- Loading branch information
Showing
1 changed file
with
12 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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` |