googleapis / googleapis/google-cloud-python

Create UPGRADING.md Migration Guide

未关闭
#15,297 1 条评论 0 个 reaction 已指派 1 人 已被 @gkevinzheng 认领 在 GitHub 查看
api: bigtable priority: p3 type: feature request
主要语言
Python
星标
5.4k
派生
1.8k
平均合并
2 天 23 小时
30 天内合并 PR
123

描述

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

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。