Skip to content

Commit f417350

Browse files
committed
Add development instructions
1 parent 4472bde commit f417350

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,6 +182,34 @@ To start contributing to this plugin, review the [Contributing to
182182
Pelican](https://docs.getpelican.com/en/latest/contribute.html) documentation, beginning
183183
with the **Contributing Code** section.
184184
185+
## Development
186+
187+
This plugin is developed using [pixi](https://pixi.sh). [Install
188+
pixi](https://pixi.sh/latest/#installation), then checkout this repository.
189+
190+
Prime the development environment with: `pixi install`, then run test units with:
191+
192+
```sh
193+
pixi run test
194+
pixi run test-cov # runs tests and measures coverage
195+
```
196+
197+
To run the unit tests for different versions of Python do one or more of the items below:
198+
199+
```sh
200+
pixi run -e test39 test; done
201+
pixi run -e test310 test; done
202+
pixi run -e test311 test; done
203+
pixi run -e test312 test; done
204+
pixi run -e test313 test; done
205+
```
206+
207+
### Releasing
208+
209+
Releasing is based on a GitHub workflow, tied to repository tags on the main development
210+
branch. Release deployment is conducted automatically on PyPI and GitHub releases after
211+
appropriate quality control and testing.
212+
185213
## License
186214
187215
This project was inspired by the [original BibTeX

0 commit comments

Comments
 (0)