Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased] - To be 0.7.0
## [Unreleased]

## [0.7.0]

### Added

Expand Down Expand Up @@ -48,7 +50,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
[#56]: https://github.com/SAP/data-attribute-recommendation-python-sdk/pull/56
[#57]: https://github.com/SAP/data-attribute-recommendation-python-sdk/pull/57


## [0.6.7]

### Changed
Expand Down Expand Up @@ -109,7 +110,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

* First public release

[Unreleased]: https://github.com/SAP/data-attribute-recommendation-python-sdk/compare/v0.6.8...HEAD
[Unreleased]: https://github.com/SAP/data-attribute-recommendation-python-sdk/compare/v0.7.0...HEAD
[0.7.0]: https://github.com/SAP/data-attribute-recommendation-python-sdk/compare/v0.6.8...0.7.0
[0.6.8]: https://github.com/SAP/data-attribute-recommendation-python-sdk/compare/v0.6.7...0.6.8
[0.6.7]: https://github.com/SAP/data-attribute-recommendation-python-sdk/compare/v0.6.6...0.6.7
[0.6.6]: https://github.com/SAP/data-attribute-recommendation-python-sdk/compare/v0.6.5...0.6.6
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ Goals of this SDK:

See [CHANGELOG.md].

Note that this project follows [Semantic Versioning](https://semver.org/). Versions
below `1.0.0` are not guaranteed to have a stable API. For this reason, please
pay attention to the [CHANGELOG.md].

## Resources

* [Tutorials on Data Attribute Recommendation] - **Free Trial Available**
Expand Down
12 changes: 12 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,18 @@ Features
- Fully type annotated for great autocomplete experience
- Supports Python 3.5 up to 3.8

Release Notes
-------------

See the `Changelog`_ on GitHub.

Note that this project follows `Semantic Versioning`_. Versions
below `1.0.0` are not guaranteed to have a stable API. For this reason, please
pay attention to the `Changelog`_.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good idea. I'm, however, not sure how many people might read this here. Should we also add this to the README file in the first few lines to make this clear to anyone using the SDK?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I added it in the README above. Is that what you had in mind?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I see that this is actually sourced by the README file. Thanks!


.. _Changelog: https://github.com/SAP/data-attribute-recommendation-python-sdk/blob/master/CHANGELOG.md
.. _Semantic Versioning: https://semver.org/

Getting Started
---------------

Expand Down