跳转到主要内容

DKIST校准套件中使用的常用数学功能

项目描述

dkist-processing-math包含DKIST数据处理软件堆栈中使用的所有数学函数。

开发

git clone git@bitbucket.org:dkistdc/dkist-processing-visp.git
cd dkist-processing-visp
pre-commit install
pip install -e .[test]
pytest -v --cov dkist_processing_visp

变更日志

当你对这个仓库进行任何更改时,它必须伴随一个变更日志文件。该仓库的变更日志使用towncrier包。下一个发布版本的变更日志条目作为单个文件(每个更改一个文件)添加到changelog/目录中。

编写变更日志条目

与更改一起应添加到changelog/目录中的变更日志条目。该目录中文件的名称遵循特定的模板

<PULL REQUEST NUMBER>.<TYPE>[.<COUNTER>].rst

字段具有以下含义

  • <PULL REQUEST NUMBER>:这是拉取请求的编号,以便人们可以从变更日志条目跳转到BitBucket上的diff。

  • <TYPE>:这是更改的类型,必须是以下描述中的一个值。

  • <COUNTER>:这是一个可选字段,如果你对同一类型的更改进行了多次更改,你可以将计数器附加到后续的更改中,例如,对于同一个PR中的两个bugfix更改,可以使用100.bugfix.rst100.bugfix.1.rst

可能的类型列表在pyproject.toml的towncrier部分中定义,类型如下:

  • feature:这是一个新的代码功能。

  • bugfix:这是一个修复错误的更改。

  • doc:这是一个文档更改。

  • 删除:公共API的弃用或删除。

  • 杂项:任何不适合其他地方的小改动,例如对包基础设施的更改。

在发布时渲染变更日志

当你准备标记一个发布版本时,首先必须运行 towncrier 来渲染变更日志。以下是该步骤的详细说明

  • 使用你想要标记的版本号运行 towncrier build –version vx.y.z

  • 同意让 towncrier 删除片段。

  • 提交你的更改。

  • 标记发布版本。

注意:如果你忘记在标记的发布版本中添加变更日志条目(无论是手动还是通过 towncrier 自动),则 Bitbucket 管道将失败。为了能够使用相同的标签,你必须在本地和远程分支上删除它

# First, actually update the CHANGELOG and commit the update
git commit

# Delete tags
git tag -d vWHATEVER.THE.VERSION
git push --delete origin vWHATEVER.THE.VERSION

# Re-tag with the same version
git tag vWHATEVER.THE.VERSION
git push --tags origin main

项目详情


下载文件

下载适合您平台的应用文件。如果您不确定选择哪个,请了解更多关于 安装包 的信息。

源代码分布

dkist-processing-math-2.1.0.tar.gz (25.0 kB 查看哈希值)

上传时间 源代码

由以下机构支持