# Changelog

All notable changes to the GL AIP Python SDK and CLI are documented here.\
Updates follow [Semantic Versioning](https://semver.org/) and the format is inspired by [Keep a Changelog](https://keepachangelog.com/).

## No entries yet

*No entries yet. Document new features, changes, and fixes here before tagging the next release.*

### How to Contribute to the Changelog

When preparing a release:

{% stepper %}
{% step %}

### Add entries for the release

Add a new section under **\[Unreleased]** for each category (`Added`, `Changed`, `Fixed`, `Deprecated`, `Removed`, `Security`). Leave the category out if there are no entries.
{% endstep %}

{% step %}

### Move notes into a version block

Move the collected notes into a new version block when the release is tagged.
{% endstep %}

{% step %}

### Include upgrade or migration pointers

Include upgrade or migration pointers and link to the detailed [Upgrade Guides](https://gdplabs.gitbook.io/gl-aip/resources/upgrade-guide) when applicable.
{% endstep %}

{% step %}

### Reference issues or PRs

Reference relevant GitHub issues or pull requests if the repository is public.
{% endstep %}
{% endstepper %}

Need migration steps? Capture them in the upgrade guide and cross-link the section from here.