DEVELOPMENT.md

Making a Release

Follow semantic versioning and make sure the changelog is up-to-date.

For non prerelease level also update README.md and CHANGELOG.md and make a release on github including copying the relevant info from the changelog file there.

We use Versioneer to automatically update the version string (of a release but also in development). This means for a release a new git tag should be created. The tag should be of the form vX.Y or vX.Y.Z and generally follow pep440 with a prefixed "v".

git tag  -a vX.Y -m "version X.Y"
git push
git push origin --tags
python setup.py sdist upload -r pypi  # better use twine for uploading, see below

To ensure a secure upload use twine:

# Create some distributions in the normal way:
python setup.py sdist
# Upload with twine:
twine upload dist/*

Development

Development of the MDsrv is coordinated through the repository on github. Please use the issue tracker there to report bugs or suggest improvements.

To participate in developing for the MDsrv you need a local copy of the source code, which you can obtain by forking the repository on github. Read about how to fork a repository, sync a fork and start a pull request.