Release checklist
=================

Things to remember when making a new release of pandas-validation.

#.  Changes should be made to some branch other than master (a pull request
    should then be created before making the release).

#.  Make desirable changes to the code.

#.  Run tests with PEP8 check and report coverage:

    .. code-block:: none

        $ py.test -v --pep8 pandasvalidation.py
        $ coverage run -m py.test
        $ coverage report --include pandasvalidation.py -m

#.  Update `README.rst` and the documentation (in `docs/`).

    .. code-block:: none

        $ sphinx-build -b html ./docs/source ./docs/_build/html

#.  Update `CHANGELOG.rst`.

#.  Update the release (version) numbers in `setup.py` and
    `pandasvalidation.py`.

#.  Create pull request(s) with changes for the new release.

#.  Create distributions and upload the files to
    `PyPI <https://pypi.python.org/pypi>`_ with
    `twine <https://github.com/pypa/twine>`_.

    .. code-block:: none

        $ python setup.py sdist bdist_wheel
        $ twine upload dist/*

#.  Create the new release in GitHub.

Release checklist
=================

Things to remember when making a new release of pandas-validation.

#.  Changes should be made to some branch other than master (a pull request
    should then be created before making the release).

#.  Make desirable changes to the code.

#.  Run tests with PEP8 check and report coverage:

    .. code-block:: none

        $ py.test -v --pep8 pandasvalidation.py
        $ coverage run -m py.test
        $ coverage report --include pandasvalidation.py -m

#.  Update `README.rst` and the documentation (in `docs/`).

    .. code-block:: none

        $ sphinx-build -b html ./docs/source ./docs/_build/html

#.  Update `CHANGELOG.rst`.

#.  Update the release (version) number in `setup.py` and
    `pandasvalidation.py`. Use `Semantic Versioning <http://semver.org>`_.

#.  Create pull request(s) with changes for the new release.

#.  Create distributions and upload the files to
    `PyPI <https://pypi.python.org/pypi>`_ with
    `twine <https://github.com/pypa/twine>`_.

    .. code-block:: none

        $ python setup.py sdist bdist_wheel
        $ twine upload dist/*

#.  Create the new release in GitHub.

Add url to Semantic Versioning
Add url to Semantic Versioning
