APIChangeLog.md
Release Note Guidelines:
- Please make your note the title of this PR
- Tag Adrian Collins (Shippo Technical Writer) as a reviewer if you'd like any input on wording or customer perspective
-
Include the date the change was (or will be) released. For example
Jun 25 2024 -
Include a severity level of the change.
- Patch: backwards compatible bug fixes
- Minor: adding, updating, or removing deprecated functionality in a backwards compatible manner
- Major: incompatible API changes or new products/tools (uncommon - requires new API version)
- Include the relevant high-level product area from the customer's perspective (eg, Tracking)
-
Include 1 line about user-impacting changes. You can use the following templates to get you started:
- Minor: The Shippo API now supports xxxxx for Tracking
- Patch: We've updated our API to xxxxx
- Minor: Our API now no longer does Y when you Z a Label
- Link to Shippo Docs as relevant (anything beyond 1 line should be in docs)
Reference:
- Release notes are displayed publicly here https://docs.goshippo.com/docs/api_concepts/apichangelog/
- Shippo Release Notes guide https://shippo.atlassian.net/wiki/spaces/DR/pages/2926084180/Release+Notes
- Release Types guide (Patch, Minor, Major) https://shippo.atlassian.net/wiki/spaces/DR/pages/3484024866/Release+Types