DOC: update contributing guide to reflect the preferred practice
未关闭
还没有人认领这个 Issue。
documentation
infrastructure
- 主要语言
- 没有语言数据
- 星标
- 673
- 派生
- 229
- PR 合并指标
- 30 天内没有已合并 PR
描述
Currently missing points:
- No outputs should be included in the notebooks
- we do prefer
.mdfiles as opposed to.ipynb.
Maybe the updated guide should be in a separate file, and keep the absolute newcomer version, that we currently have, in the README?
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
调研方向
阅读当前的贡献指南和 README，了解 notebook 实践记录在哪里。更新指南，明确说明 notebook 不应包含输出内容，并且优先使用 .md 文件而不是 .ipynb；当所选指南结构清楚地体现这两点时，即视为完成。
由索引模型根据 Issue 内容生成。
评估
- 领域
- documentation
- Issue 类型
- 文档
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 活跃度
- 停滞
- 描述清晰度
- 基本清楚
- 新手友好度
- 35/100