Clarify commit suggestions

未关闭
#39 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
半天
新手友好度
45/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
git
领域
documentation

调研方向

从 Collaborative Distributed Science Guide 中链接的“Formatting and Naming Conventions”部分开始,审阅其中当前关于 commit 的指导。完成的标准是,该部分清楚地说明 commit 消息的用途、可读性以及对所执行工作的理解,同时链接到良好的机器可读 commit 实践,并强调为什么要进行更改。

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

描述

design documentation help wanted question

The Formatting and Naming Conventions section could use a re-visit. I think we need to elevate the commit portion, but also make it more in-line with practice. We should summarize the purpose of commit messages, highlighting important aspects of readability and understanding processes done. Then also link to good practices for, e.g., machine-readability and such, but the ultimate goal of understandable commits (why is this change happening) needs to be expressed clearly.

主要语言
Python
星标
1
派生
1
平均合并
6 天 1 小时
30 天内合并 PR
1

环境准备

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

从这里开始

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

Imageomics/Collaborative-distributed-science-guide 的其他 Issue

查看 Imageomics/Collaborative-distributed-science-guide 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

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