Release Process

This project follows the python form of Semantic Versioning as detailed in PEP 440.

For git tags we use the version as describe in Versioning Schema preceded by a v.

A release on git is just a tagged commit on the master branch.

Here we detail the process of creating a new Github release.

Create and merge a pull request that:
- increases the version number in xain_fl/__version__.py according the versioning schema.
- updates the CHANGELOG.md with all notable changes for the release.
- possibly update the Development Status classifiers in the setup.py. You can check supported classifiers in the pypi website.
Got to the Github Releases tab and create a new release:
- for the tag version use the version defined in 1. preceded by a v, e.g. v0.3.2, and target master.
- for the release title use the same as the tag version.
- for the release description, copy the section from the CHANGELOG.md related to this version.
- possibly check the This is a pre-release check box.
- Publish the release.

Here we detail the process of building and pushing a python package to PyPi. You can check more information in the Python Packaging User Guide.

Checkout the current git tag e.g.
```
$ git checkout v0.3.2
```
Generate the distribution archives:
```
$ python setup.py sdist bdist_wheel
```
Upload the distribution archives using the correct PyPi credentials:
```
$ python -m twine upload dist/*
```

Provide feedback