设置自述文件#

为用户和开发人员提供跨存储库的一致性可以节省宝贵时间并提高用户生产力。

在更大范围内，让 Jupyter 名称突出显示在存储库的 README.md 文件中，可以提高项目名称的知名度。

Jupyter 项目存储库中的推荐元素#

在存储库描述中添加链接#

请在存储库的描述中包含指向文档的链接。

Documentation link in GitHub jupyter/notebook repo description annotated with a red speech bubble reading "Add link to documentation (usually a link to Read the Docs.)")

自述文件中的徽章#

个人查找文档的一种常见方式是查找并单击通常在标题后紧跟的文档徽章。另一个好处是，如果文档未正确呈现，则可以轻松地通过视觉方式进行指示。

The GitHub-rendered view of the README.md file for the Jupyter Notebook project is annotated with a red speech bubble reading "Add badge for Docs."

自述文件中的资源部分#

在 README.md 末尾的资源部分为用户提供了有关各个项目和更大的 Project Jupyter 组织的有用链接和信息。确保包含指向各个项目的演示笔记本（如果可用）的任何链接。

例如，以下是 [jupyter/notebook 中的资源部分](https://github.com/jupyter/notebook/blob/master/README.md#resources)

向新或现有的 GitHub 存储库添加文档的清单#

[ ] 在存储库描述中添加指向文档的链接（需要 GitHub 存储库权限）
[ ] 向自述文件添加徽章（编辑 README.md 并提交拉取请求）
[ ] 向自述文件添加资源部分（编辑 README.md 并提交拉取请求）

日期：1-4-2016 修订日期：1-7-2016