HazyResearch/fonduer

View on GitHub
docs/dev/changelog.rst

Summary

Maintainability
Test Coverage
Changelog
=========

All notable changes to this project will be documented in this file.

The format is based on `Keep a Changelog`_ and this project adheres to
`Semantic Versioning 2.0.0`_ conventions. The maintainers will create a git tag
for each release and increment the version number found in
`fonduer/\_version.py`_ accordingly. We release tagged versions to `PyPI`_
automatically using `GitHub Actions`_.

.. note::
    Fonduer is still under active development and APIs may still change
    rapidly. Until we release v1.0.0, changes in MINOR version indicate
    backward incompatible changes.

.. include:: ../../CHANGELOG.rst

.. _Keep a Changelog: https://keepachangelog.com/en/1.0.0/
.. _PyPI: https://pypi.org/project/fonduer/
.. _Semantic Versioning 2.0.0: https://semver.org/
.. _GitHub Actions: https://github.com/HazyResearch/fonduer/actions
.. _fonduer/\_version.py: https://github.com/HazyResearch/fonduer/blob/master/src/fonduer/_version.py