Skip to content

Commit

Permalink
Fix python version to 3.12 in contribution guideline.
Browse files Browse the repository at this point in the history
  • Loading branch information
braniii committed Nov 7, 2023
1 parent cbe0ed7 commit 407d9db
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If you want to request a change, you first have to [fork the repository](https:/
=== "bash + conda"

``` bash
conda create -n normi -c conda-forge python
conda create -n normi -c conda-forge python=3.12
conda activate normi
python -m pip install -e .[all]
```
Expand All @@ -38,7 +38,7 @@ If you want to request a change, you first have to [fork the repository](https:/
=== "zsh + conda"

``` zsh
conda create -n normi -c conda-forge python
conda create -n normi -c conda-forge python=3.12
conda activate normi
python -m pip install -e .\[all]
```
Expand Down
6 changes: 6 additions & 0 deletions docs/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ This guide will give you an overview of how to publish a new version of normi. I
## Prepare New Release

Please ensure that,

1. the version number in `setup.py` and `src/normi/__init__.py` are bumped,
1. a new tag is created via `git tag v0.*.*` and pushed `git push --tags`, and
1. the changelog includes the new tag and all changes of the release.
Expand All @@ -14,6 +15,11 @@ Please ensure that,
There is an CI to publish new versions automatically. Therefore, a new release
needs to be published. Please ensure that each release is based on a tag.

## Build and Upload to PyPI (preferred)

It is as simple as creating a new release from the new tag. The Github action
will do the rest.

## Build and Upload to PyPI (admin only)

For an introduction, please take a look at the [PyPI manual](https://packaging.python.org/en/latest/tutorials/packaging-projects/).
Expand Down

0 comments on commit 407d9db

Please sign in to comment.