Hacktoberfest 2026：维护者为十月标记出来的 issue，仍然开放、适合新手。 浏览 Hacktoberfest issue

add script to generate all non-code files automatically if they don't exist

未关闭
  • 哪里不对？
#27 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
25/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
停滞
技术栈
jupyter-notebook, python
领域
build-system, documentation, testing, tooling

调研方向

首先检查所请求的生成文件：setup.py、conf.py、MANIFEST.in、README.md、requirements.txt、license.txt、api.rst、index.rst、tutorials.rst 以及示例 notebook。定义脚本应如何检测缺失文件，以及 setup.py 中的值如何影响这些文件。完成的标准是生成缺失的 package、test、example 和 documentation 文件，并将所请求的 GitHub、Travis、Read the Docs、release、fork 和 pip 步骤输出为待办事项列表。

由索引模型根据 Issue 内容生成。

描述

  • setup.py (use folder name as name of project, and if any of the below are specified, change the script accordingly to reference them)

other info could be read from setup.py

  • conf.py
  • MANIFEST.in
  • README.md
  • requirements.txt
  • license.txt
  • basic test (so pytest can run)
  • basic example (so sphinx compiles)
  • api.rst
  • index.rst
  • tutorials.rst
  • sample tutorial notebook

then output a "to do" list of how to:

  • set up github web hooks for slack
  • get travis configured
  • compile sphinx web page
  • register on readthedocs and publish readthedocs page
  • do a github release
  • set up forks on github for development (once package is "live," rather than modifying master branch directly)
  • push to pip (after package is ready for release)
  • install package from pip
主要语言
Jupyter Notebook
星标
17
派生
4
30 天内没有已合并 PR

环境准备

  • 提供 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

ContextLab/CDL-tutorials 的其他 Issue

查看 ContextLab/CDL-tutorials 的全部 Issue

相似的 Issue

更多 Build System Issue

把新 issue 发到你的邮箱

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