DOC: update contributing guide to reflect the preferred practice

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

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
35/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
领域
documentation

调研方向

阅读当前的贡献指南和 README,了解 notebook 实践记录在哪里。更新指南,明确说明 notebook 不应包含输出内容,并且优先使用 .md 文件而不是 .ipynb;当所选指南结构清楚地体现这两点时,即视为完成。

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

描述

documentation infrastructure

Currently missing points:

  • No outputs should be included in the notebooks
  • we do prefer .md files 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?

主要语言
没有语言数据
星标
673
派生
229
PR 合并指标
30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

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

numpy/numpy-tutorials 的其他 Issue

查看 numpy/numpy-tutorials 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

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