未验证 提交 26b3d716 编写于 作者: F Frost Ming

doc: update contributing guide

上级 bcb09cea
......@@ -13,7 +13,7 @@ jobs:
python-version: 3.9
- name: Install PDM
run: |
python -m pip install click
python -m pip install rich
python install-pdm.py --version head
echo "$HOME/.local/bin" >> $GITHUB_PATH
- name: Bootstrap poetry
......
......@@ -78,13 +78,13 @@ The test suite is still simple and needs expansion! Please help write more test
!!! note
You can also run your test suite against all supported Python version using `tox` with the `tox-pdm` plugin.
You can either run it by yourself with:
```shell
tox
```
or from `pdm` with:
```shell
pdm run tox
```
......@@ -126,3 +126,25 @@ If you make some changes to the `docs/` and you want to preview the build result
```bash
pdm run doc
```
## Release
Once all changes are done and ready to release, you can preview the changelog contents by running:
```bash
pdm run release --dry-run
```
Make sure the next version and the changelog are as expected in the output.
Then cut a release on the **main** branch:
```bash
pdm run release
```
GitHub action will create the release and upload the distributions to PyPI.
Read more options about version bumping by `pdm run release --help`.
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册