googleapis / googleapis/google-cloud-python

Create UPGRADING.md Migration Guide

Open
#15,297 1 comment 0 reactions 1 assignee Claimed by @gkevinzheng View on GitHub
api: bigtable priority: p3 type: feature request
Dominant language
Python
Stars
5.4k
Forks
1.8k
Avg merge
3d 4h
Merged PRs (30d)
122

Description

We expect the shim work to require a breaking change. We want the change to be as small as possible, but we may expect a different sequencing of exceptions, etc.

To track this, we need to maintain a migration guide in an UPGRADING.md file, detailing what users may need to change in their code. We should also link this into the docs. See [the one in python-logging](https://github.com/googleapis/python-logging/blob/main/UPGRADING.md) for an example

Ideally, we should start this immediately, and update it as changes are made

The content of this file should also be exposed in the public docs. But the first step is collecting the information, and then we can discuss the right places to expose it

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.