 修复看懂 Pull Request 实战全流程)
astropy 开源贡献完整指南用一个 len() 修复看懂 Pull Request 实战全流程【免费下载链接】lapAn offline-first photo manager for large local libraries项目地址: https://gitcode.com/GitHub_Trending/lap3/lap本文以 astropy 修复坐标对象不支持 len()的问题issue 1761 / PR 1917为例带你完整走一遍开源贡献流程从准备环境、写一个必然失败的测试到实现修复、分层验证、推送代码、发起 Pull Request 与补写 changelog。看完你不仅知道每条命令怎么敲更清楚每一步背后的理由——而这正是社区评审时最在意的部分。为什么拿这个 issue 当练习选它当例子是因为它门槛低却五脏俱全它在 astropy 的 issue 列表里标着 easy属于入门级新人上手不费劲一个小小的 len() 缺口恰好把贡献闭环的每个环节都踩了一遍定位测试目录、写回归测试、改源码、组织 git 提交、发起评审、更新 changelog这个改动是真实合进过主干的在 CHANGES.rst 里能查到 Fixed bug which causedlen()not to work for coordinate objects 这一条说明它不是纸上谈兵。换句话说把这条路径走完你就基本掌握了社区期望的那套开发习惯test-first、小粒度 commit、news fragment 变更日志。先把仓库拉齐同步 upstream 再开独立分支动手前先让本地副本跟上上游的最新状态。这一步的意义是——让后续所有操作都基于最新代码避免你站在一条过时的基线上提交。先同步上游的提交和标签这条命令只更新本地对上游的认识不动你的工作区git fetch upstream --tags接着基于上游主分支切一条干净的修复分支git switch -c fix-1761 upstream/main分支名带上 issue 号fix-1761是个好习惯日后回看一眼就知道这条分支在干什么。然后进入你自己的 astropy 开发环境用可编辑方式装上当前分支并带上全部开发依赖conda activate astropy-dev python -m pip install --editable . --group dev_all这里的 dev_all 依赖组在 pyproject.toml 里就有定义形如dev_all [ ... ]作用是把测试和开发要用到的额外包一次性装齐。装不上时可以先升级 pip 再试顺手conda update conda --name base保持 conda 新版也是稳妥的做法。红如何写一个当前必然失败的测试很多人会忍不住先改代码社区却要求你先交一个测试。为什么因为一个会失败的测试干了兩件事它把这次修复钉住让自动化流程能反复验证它也是防回归的护栏保证以后没人把这处悄悄改坏。先确认现有测试跑得起来。这个 issue 属于 astropy.coordinates 子包测试就放在astropy/coordinates/tests下其余子包也基本是这种布局。先跑一遍这个目录pytest astropy/coordinates/tests如果涉及远程数据再加--remote-data。若现有测试在 bug 还在的情况下全绿说明你还得新写一个测试把它暴露出来。目录里的测试通常拆成多个模块。这个 issue 影响的是坐标数组所以新测试放进test_arrays.py最合适拿不准时可以在社区列表问一句。写的时候参考文件里已有的test_函数照葫芦画瓢最省事再给新函数起个直白的名字比如test_array_len。写完再跑一遍单文件测试pytest astropy/coordinates/tests/test_arrays.py这时你会看到它失败而且失败得很对——断言len(c)等于 5 的那一行抛出了TypeError: object of type ICRS has no len()。看到这种失败就对了bug 已经被测试钉死了。绿让测试通过顺便看清现在代码长什么样当年那次修复非常短在coordsystems.py的SphericalCoordinatesBase基类里加了一个__len__方法def __len__(self): return len(self.lonangle)lonangle存的是表示经度有时是 RA、有时是 longitude的 Angle 对象。对数组里的一个 Angle 调len()就免费拿到了 Angle 类为标量情况定义好的全部行为。这里藏着一个值得带走的原则复用已有的行为避免在两个地方各维护一套标量逻辑。需要说明的是代码后来重构过你现在按老描述去coordsystems.py里找是找不到的。ICRS、FK5 这些帧类现在统一继承baseframe.py里的BaseCoordinateFramelen()的行为则交给通用的形状混入类ShapedLikeNDArray提供实现在shapes.py中def __len__(self) - int: if self.isscalar: raise TypeError(fScalar {self.__class__.__name__!r} object has no len()) return self.shape[0]规则很直白标量坐标调len()抛 TypeError数组坐标返回第一维长度坐标帧通过shape属性参与这套机制。三层测试怎么跑单文件、子包、全仓库改完之后验证要分层来别只跑一个文件就交差你写的那个测试现在通过了吗跑pytest astropy/coordinates/tests/test_arrays.py确认其余坐标测试还绿吗跑pytest astropy/coordinates/确认没波及邻居整个 astropy 还过吗在顶层目录跑pytest做最后兜底。这一步比较吃机器耐心等。判定标准只有一条skip 和 xfailed 是允许的出现 fail 或 error 才算你搞坏了东西。卡住别硬扛去社区列表问比闷头耗强。提交前自查边界情况与 git 纪律提 PR 之前值得先把自己当评审员审一遍还有没有没覆盖的角落这个len()至少有两个边界值得补对一个不是数组的坐标调len()行为应该是怎样坐标数组里只有一个元素时len()是否成立。对预期会抛异常的情况pytest 有个顺手写法把会出错的代码放进with块with pytest.raises(TypeError): len(c)当年这里选择了抛 TypeError理由是用户必须清楚自己拿到的是标量、而不是只有一个元素的数组否则之后对它做索引会踩到不一致的行为。拿不准该怎么取舍时去 issue 页面问或者自己定一个并在 PR 里说清楚选了哪个、为什么。边界补完接下来是 git 的纪律部分核心就一条add 和 commit 分两步走。先git status看看动了哪些文件再用git add file把改动放进暂存区最后git commit -m ...落进仓库。分两步的好处是——撤销暂存比撤销提交容易得多git status甚至会贴心地把 unstage 命令打印给你。改动零散、又想归到同一个提交时暂存机制特别好用改一处、add 一次全就绪了再一起 commit。commit message 要短。第一行写清楚做了什么正文可补细节。这条 issue 的修复提交长这样多行写法里带上Closes #1761变更被接受时会自动关闭对应 issuegit commit -m Add len() to coordinates Closes #1761提交后随手git log扫一眼历史确认 message 干净不对就用git commit --amend修正。到这一步本地已有改动、上游还一无所知——下一节才把它们送到社区眼前。交付给社区push、Pull Request 与 news fragment先把分支推到你 fork 上git push origin fix-1761然后到你 fork 的仓库页面从分支下拉框里选中这条修复分支点 Pull Request 按钮发起评审。标题要起得能说明问题描述里带上#1761这种带井号的 issue 号好让 issue 和 PR 自动关联起来。还差最后一块changelog。没人会天天盯着仓库手搓变更列表所以约定每个贡献者顺手补一条 news fragment。新建文件docs/changes/coordinates/PULL REQUEST.feature.rst其中PULL REQUEST换成你的 PR 号本例是 1917内容一句话概括做了什么即可Implemented len() for coordinate objects.双反引号让这段文字以等宽字体渲染。命名规则值得记牢文件名是PULL REQUEST.TYPE.rstTYPE取 feature新特性、apiAPI 变更、bugfix缺陷修复、perf可度量的性能改进或 other其他。改动属于哪个子包就放进哪个子目录比如 coordinates 子包放docs/changes/coordinates/且子目录里不允许 other 类型一个改动若既加特性又改 API可以各放一条不同类型的文件。补完 changelog照例 add、commitmessage 写 Add changelog entry、push。评审来了怎么办评审里被要求改是最正常的状态。你在本地改好、commit、再 push 到 forkGitHub 会自动把改动滚进你的 PR不用重开。就这一个循环改到评审通过为止。走到这里你就完整走通了开源贡献流程——红、绿、交付一个都不缺 。【免费下载链接】lapAn offline-first photo manager for large local libraries项目地址: https://gitcode.com/GitHub_Trending/lap3/lap创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
astropy 开源贡献完整指南用一个 len() 修复看懂 Pull Request 实战全流程【免费下载链接】lapAn offline-first photo manager for large local libraries项目地址: https://gitcode.com/GitHub_Trending/lap3/lap本文以 astropy 修复坐标对象不支持 len()的问题issue 1761 / PR 1917为例带你完整走一遍开源贡献流程从准备环境、写一个必然失败的测试到实现修复、分层验证、推送代码、发起 Pull Request 与补写 changelog。看完你不仅知道每条命令怎么敲更清楚每一步背后的理由——而这正是社区评审时最在意的部分。为什么拿这个 issue 当练习选它当例子是因为它门槛低却五脏俱全它在 astropy 的 issue 列表里标着 easy属于入门级新人上手不费劲一个小小的 len() 缺口恰好把贡献闭环的每个环节都踩了一遍定位测试目录、写回归测试、改源码、组织 git 提交、发起评审、更新 changelog这个改动是真实合进过主干的在 CHANGES.rst 里能查到 Fixed bug which causedlen()not to work for coordinate objects 这一条说明它不是纸上谈兵。换句话说把这条路径走完你就基本掌握了社区期望的那套开发习惯test-first、小粒度 commit、news fragment 变更日志。先把仓库拉齐同步 upstream 再开独立分支动手前先让本地副本跟上上游的最新状态。这一步的意义是——让后续所有操作都基于最新代码避免你站在一条过时的基线上提交。先同步上游的提交和标签这条命令只更新本地对上游的认识不动你的工作区git fetch upstream --tags接着基于上游主分支切一条干净的修复分支git switch -c fix-1761 upstream/main分支名带上 issue 号fix-1761是个好习惯日后回看一眼就知道这条分支在干什么。然后进入你自己的 astropy 开发环境用可编辑方式装上当前分支并带上全部开发依赖conda activate astropy-dev python -m pip install --editable . --group dev_all这里的 dev_all 依赖组在 pyproject.toml 里就有定义形如dev_all [ ... ]作用是把测试和开发要用到的额外包一次性装齐。装不上时可以先升级 pip 再试顺手conda update conda --name base保持 conda 新版也是稳妥的做法。红如何写一个当前必然失败的测试很多人会忍不住先改代码社区却要求你先交一个测试。为什么因为一个会失败的测试干了兩件事它把这次修复钉住让自动化流程能反复验证它也是防回归的护栏保证以后没人把这处悄悄改坏。先确认现有测试跑得起来。这个 issue 属于 astropy.coordinates 子包测试就放在astropy/coordinates/tests下其余子包也基本是这种布局。先跑一遍这个目录pytest astropy/coordinates/tests如果涉及远程数据再加--remote-data。若现有测试在 bug 还在的情况下全绿说明你还得新写一个测试把它暴露出来。目录里的测试通常拆成多个模块。这个 issue 影响的是坐标数组所以新测试放进test_arrays.py最合适拿不准时可以在社区列表问一句。写的时候参考文件里已有的test_函数照葫芦画瓢最省事再给新函数起个直白的名字比如test_array_len。写完再跑一遍单文件测试pytest astropy/coordinates/tests/test_arrays.py这时你会看到它失败而且失败得很对——断言len(c)等于 5 的那一行抛出了TypeError: object of type ICRS has no len()。看到这种失败就对了bug 已经被测试钉死了。绿让测试通过顺便看清现在代码长什么样当年那次修复非常短在coordsystems.py的SphericalCoordinatesBase基类里加了一个__len__方法def __len__(self): return len(self.lonangle)lonangle存的是表示经度有时是 RA、有时是 longitude的 Angle 对象。对数组里的一个 Angle 调len()就免费拿到了 Angle 类为标量情况定义好的全部行为。这里藏着一个值得带走的原则复用已有的行为避免在两个地方各维护一套标量逻辑。需要说明的是代码后来重构过你现在按老描述去coordsystems.py里找是找不到的。ICRS、FK5 这些帧类现在统一继承baseframe.py里的BaseCoordinateFramelen()的行为则交给通用的形状混入类ShapedLikeNDArray提供实现在shapes.py中def __len__(self) - int: if self.isscalar: raise TypeError(fScalar {self.__class__.__name__!r} object has no len()) return self.shape[0]规则很直白标量坐标调len()抛 TypeError数组坐标返回第一维长度坐标帧通过shape属性参与这套机制。三层测试怎么跑单文件、子包、全仓库改完之后验证要分层来别只跑一个文件就交差你写的那个测试现在通过了吗跑pytest astropy/coordinates/tests/test_arrays.py确认其余坐标测试还绿吗跑pytest astropy/coordinates/确认没波及邻居整个 astropy 还过吗在顶层目录跑pytest做最后兜底。这一步比较吃机器耐心等。判定标准只有一条skip 和 xfailed 是允许的出现 fail 或 error 才算你搞坏了东西。卡住别硬扛去社区列表问比闷头耗强。提交前自查边界情况与 git 纪律提 PR 之前值得先把自己当评审员审一遍还有没有没覆盖的角落这个len()至少有两个边界值得补对一个不是数组的坐标调len()行为应该是怎样坐标数组里只有一个元素时len()是否成立。对预期会抛异常的情况pytest 有个顺手写法把会出错的代码放进with块with pytest.raises(TypeError): len(c)当年这里选择了抛 TypeError理由是用户必须清楚自己拿到的是标量、而不是只有一个元素的数组否则之后对它做索引会踩到不一致的行为。拿不准该怎么取舍时去 issue 页面问或者自己定一个并在 PR 里说清楚选了哪个、为什么。边界补完接下来是 git 的纪律部分核心就一条add 和 commit 分两步走。先git status看看动了哪些文件再用git add file把改动放进暂存区最后git commit -m ...落进仓库。分两步的好处是——撤销暂存比撤销提交容易得多git status甚至会贴心地把 unstage 命令打印给你。改动零散、又想归到同一个提交时暂存机制特别好用改一处、add 一次全就绪了再一起 commit。commit message 要短。第一行写清楚做了什么正文可补细节。这条 issue 的修复提交长这样多行写法里带上Closes #1761变更被接受时会自动关闭对应 issuegit commit -m Add len() to coordinates Closes #1761提交后随手git log扫一眼历史确认 message 干净不对就用git commit --amend修正。到这一步本地已有改动、上游还一无所知——下一节才把它们送到社区眼前。交付给社区push、Pull Request 与 news fragment先把分支推到你 fork 上git push origin fix-1761然后到你 fork 的仓库页面从分支下拉框里选中这条修复分支点 Pull Request 按钮发起评审。标题要起得能说明问题描述里带上#1761这种带井号的 issue 号好让 issue 和 PR 自动关联起来。还差最后一块changelog。没人会天天盯着仓库手搓变更列表所以约定每个贡献者顺手补一条 news fragment。新建文件docs/changes/coordinates/PULL REQUEST.feature.rst其中PULL REQUEST换成你的 PR 号本例是 1917内容一句话概括做了什么即可Implemented len() for coordinate objects.双反引号让这段文字以等宽字体渲染。命名规则值得记牢文件名是PULL REQUEST.TYPE.rstTYPE取 feature新特性、apiAPI 变更、bugfix缺陷修复、perf可度量的性能改进或 other其他。改动属于哪个子包就放进哪个子目录比如 coordinates 子包放docs/changes/coordinates/且子目录里不允许 other 类型一个改动若既加特性又改 API可以各放一条不同类型的文件。补完 changelog照例 add、commitmessage 写 Add changelog entry、push。评审来了怎么办评审里被要求改是最正常的状态。你在本地改好、commit、再 push 到 forkGitHub 会自动把改动滚进你的 PR不用重开。就这一个循环改到评审通过为止。走到这里你就完整走通了开源贡献流程——红、绿、交付一个都不缺 。【免费下载链接】lapAn offline-first photo manager for large local libraries项目地址: https://gitcode.com/GitHub_Trending/lap3/lap创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
平方复杂度无法被常规优化消除｜TaoToken 统一 Key 通道实测)
