Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
51 lines (38 loc) · 1.92 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 1.92 KB
Raw

贡献指南（Contributing）

感谢你愿意为本教程出一份力！无论是纠错、补充内容还是改进文档，都非常欢迎。

可以贡献什么

  • 纠错：代码报错、统计方法用错、结论表述不严谨
  • 补充：新的模型（如 SVM / 神经网络）、新的验证方法（如时间外部验证）、新数据集
  • 文档：README 改进、注释补充、错别字、翻译
  • 体验：让脚本在更多平台（Windows / Linux）上顺畅运行

提交方式

  1. 开 Issue：描述问题或建议，附上你的环境（sessionInfo() 输出）与报错信息。
  2. 提 Pull Request： 
    git clone https://github.com/SAMCYK0921/predictive-modeling-tutorial.git
cd predictive-modeling-tutorial
git checkout -b fix/your-topic
# 修改后
git commit -m "fix: 修正第 5 章 ROC 置信区间计算"
git push origin fix/your-topic

代码规范

本教程面向自学者，因此可读性优先于技巧：

  1. 风格统一：与现有章节保持一致 —— 中文注释、## ---- 小节标题 ---- 分隔、 section("x.y 标题") 打印分节、%>% / |> 管道清晰换行。
  2. 可复现：涉及随机的步骤必须 set.seed()；不要依赖本地绝对路径， 统一使用 DATA_DIR / OUT_DIR。
  3. 输出规范：图表用 save_plot() 或 open_png() 保存到 output/， 命名沿用 ch{章号}_{含义}.png。
  4. 依赖：若新增 R 包，请同时更新 R/00_setup.R 的 required_packages 与 install_deps.R，并在 README 的依赖列表中补充。
  5. 数据：请勿提交包含个人隐私或未获授权的数据。

提交前自测

# 至少确认改动的章节能独立跑通
Rscript R/05_logistic_regression.R

# 或跑完整流程
Rscript run_all.R

行为准则

保持友善、就事论事。这是一个学习型项目，欢迎所有水平的贡献者。