为lifelines做出贡献

关于生存分析的问题?

如果您正在使用lifelines进行生存分析,并且有关于“如何做X?”或“Y的作用是什么?”的问题,最好的提问地点是我们的讨论频道或在stats.stackexchange.com

提交观察到的错误或其他问题

我们感谢所有提交的错误报告,因为这将帮助整个社区获得更好的产品。请在Github仓库中提出问题。如果可能,请提供代码片段以及您使用的lifelines版本。

提交新功能请求

请在Github仓库中提出一个问题,尽可能详细地描述你希望看到的功能。同时,链接到具有该功能的其他库/软件也是有用的。

提交代码或其他更改

如果您有兴趣为lifelines做出贡献(我们感谢您的兴趣!),我们建议首先在GitHub仓库中打开一个问题来讨论更改。从那里,我们可以一起计划如何执行更改。请参阅下面的开发部分,了解如何设置本地环境。

开发

设置一个lifelines开发环境

  1. lifelines的根目录激活您的虚拟环境(如果您计划使用一个)。

  2. 安装开发需求和 pre-commit 钩子。如果您使用的是 Mac、 Linux 或 Windows WSL,您可以使用提供的 Makefile。 只需在控制台中输入 make,您就可以开始 开发了。这还将安装开发需求。

格式化

lifelines 使用 black Python 格式化工具。有三种不同的方式来格式化你的代码。

  1. 使用 Makefile

    make lint

  2. 直接调用black并传递正确的行长度。

    black . -l 120

  3. 在提交时使用pre-commit钩子自动格式化您的代码。

    • 暂存并提交您未格式化的更改:

      git commit -m "your_commit_message"

    • 需要格式化的代码将“无法通过”提交钩子,并为您进行格式化。

    • 暂存新格式化的python代码:

      git add *.py

    • 回想你最初的提交命令并再次提交:

      git commit -m "your_commit_message"

运行测试

安装后,您可以选择运行测试套件

py.test