Python 现代开发学习笔记

(十四)GitHub 的项目说明与问题记录

1. 让仓库首页能带人运行项目

README 先说明程序能完成的任务,再给出环境、安装、运行与检查步骤。阅读统计的小项目写明 python reading.py 和 python check_reading.py;完整书籍库则列出 Python 3.12、uv sync --locked、初始化数据与检查入口。读者能从首页完成第一次运行,再进入详细文档。

仓库 About 中可以填写简短说明、项目网站与 topics。topics 使用 python、learning-notes、sqlite 等能准确描述项目的标签。License 文件说明代码的使用许可,README 的说明不能代替实际许可选择。

在 GitHub 查看文件时可以打开 History 查看文件修改,点击提交查看差异;复制链接时选择固定到某次提交的位置,读者打开后看到的内容不会随着分支后续前进而改变。

2. 用 Issue 保留能复现的问题

对于“35 分钟没有计为达标”,Issue 可以写成下面的形式:

标题:恰好35分钟的记录没有计入达标次数

输入:minutes=[35],goal=35
期望:1
实际:0
复现:运行这次提交中的 count_met([35], 35)
环境:Python 3.12;填写对应提交哈希
定位:比较条件使用了 >,任务要求是不少于目标

Issue 保存任务、讨论和复现信息,PR 保存准备合入的代码变化;报告问题不等于已经修正。实现时用一个分支关联对应 Issue,检查通过后再提出合并。

笔记正文与全部题解 · Ctrl / ⌘ K