贡献 Jupyter 笔记本#

我们创建了一系列 Jupyter 笔记本,展示了 Feature-engine 转换器的主要功能。我们在主要文档中链接了这些笔记本,为用户提供更多关于转换器及其使用方法的示例和详细信息。

注意 Jupyter 笔记本托管在一个单独的 Github 仓库 中。

以下是关于如何添加新笔记本或更新现有笔记本的一些指南。贡献工作流程与我们用于主源代码库的流程相同。

Jupyter 贡献工作流程#

  1. Fork Github 仓库

  2. 将你的分支克隆到本地计算机:git clone https://github.com/<YOURUSERNAME>/feature-engine-examples.git

  3. 进入项目目录:cd feature-engine-examples

  4. 如果你还没有这样做,请安装 feature-engine: pip install feature_engine

  5. 创建一个有意义的特性分支:git checkout -b mynotebookbranch

  6. 开发你的笔记本

  7. 将更改添加到你的fork副本中:git add .git commit -m "有意义的提交信息"git pull origin mynotebookbranch

  8. 前往你在Github上的分支,并向此仓库提交一个PR

  9. 完成

笔记本的审查过程通常比主源代码库的审查过程快得多。

Jupyter 创建指南#

如果你想添加一个新的 Jupyter 笔记本,有几点需要注意:

  • 确保您使用的数据集是公开可用的,并且具有明确的许可证,表明可以免费使用。

  • 不要将数据集上传到仓库

  • 添加关于如何获取和准备演示数据的说明

  • 在整个笔记本中,添加下一步要做什么的指南,以及输出结果的结论。

就是这样!相当直接明了。

我们期待您的贡献 :)