为本指南做出贡献¶
这个 Python Packaging User Guide 欢迎投稿人！有很多方法可以帮助我们，包括：
阅读指南并给出反馈
审查新的贡献
修改现有内容
正在写入新内容
大部分工作都在 Python Packaging User Guide 发生在 `project's GitHub repository`_ ②要开始，请查看 `open issues`_ 和 `pull requests`_ ②如果您计划编写或编辑指南，请阅读 style guide .
通过贡献 Python Packaging User Guide ，您应该遵循python打包机构的 `Contributor Code of Conduct`_ ②骚扰、人身攻击和其他不专业行为是不可接受的。
文档类型¶
此项目由四种不同的文档类型组成，具有特定的用途。当建议对项目进行新的添加时，请选择适当的文档类型。
教程¶
教程的重点是通过实现一个目标来教授读者新的概念。他们是固执己见的循序渐进的指南。它们不包括无关的警告或信息。 example tutorial-style document .
指南¶
指南的重点是完成一项特定的任务，并且可以假定具有一定程度的先决条件知识。这些与教程类似，但重点狭窄且清晰，可以根据需要提供大量警告和附加信息。他们还可以讨论完成任务的多种方法。 example guide-style document .
讨论¶
讨论的重点是理解和信息。这些都是在没有特定目标的情况下探索特定主题。 example discussion-style document .
规格¶
规范是参考文件，重点是全面记录包装工具之间互操作性的商定接口。 example specification-style document .
在本地构建指南¶
虽然不需要贡献，但在本地构建本指南以测试您的更改可能很有用。要在本地构建此指南，您需要：
Nox <https://nox.readthedocs.io/en/latest/> ②您可以使用安装或升级nox
pip：：pip install --user nox
Python 3.6.我们的构建脚本仅设计用于Python3.6。查看 Hitchhiker's Guide to Python installation instructions 在操作系统上安装python 3.6。
要构建指南，请在源文件夹中运行以下bash命令：
nox -s build
流程完成后，您可以在 ./build/html 目录。你可以打开 index.html 文件以在Web浏览器中查看指南，但建议使用HTTP服务器为指南提供服务。
您可以使用以下命令构建指南并通过HTTP服务器为其提供服务：
nox -s preview
该指南可通过http://localhost:8000进行浏览。
指南的部署位置¶
该指南通过readthedocs部署，配置位于https://readthedocs.org/projects/python packaging user guide/。它由一个自定义域提供服务，并由fast.ly提供。
样式指南¶
此样式指南对如何编写 Python Packaging User Guide . 在你开始写作之前，请回顾一下。通过遵循样式指南，您的贡献将有助于增加一个有凝聚力的整体，并使您的贡献更容易被接受到项目中。
范围¶
本指南旨在回答问题，并以准确和集中的建议解决问题。
该指南并不意味着全面，也不意味着取代单个项目的文档。例如，PIP有几十个命令、选项和设置。PIP文档详细描述了它们中的每一个，而本指南仅描述完成本指南中描述的特定任务所需的PIP部分。
观众¶
本指南的读者是任何使用带有包的Python的人。
别忘了，python社区是一个大而友好的社区。读者可能不会分享你的年龄、性别、教育、文化等等，但他们应该像你一样了解包装。
尤其要记住，并不是所有使用Python的人都将自己视为程序员。本指南的读者包括天文学家、画家或学生以及专业软件开发人员。
声音和音调¶
在写这本指南的时候，即使你有所有的答案，也要努力用一种平易近人、谦虚的声音来写作。
想象一下，你正在和一个你认识的聪明和熟练的人一起进行一个Python项目。你喜欢和他们一起工作，他们也喜欢和你一起工作。那个人问了你一个问题，你知道答案。你怎么回应？ That 你应该如何写这本指南。
这里有一个快速的检查：试着大声朗读，以了解你写作的声音和语调。这听起来像是你想说的话，还是听起来像是你在表演一个角色或发表演讲？你可以随意使用缩略语，不用担心遵守繁琐的语法规则。如果你想用介词结束一个句子，你就可以用介词结束它。
撰写指南时，根据主题的严肃性和难度调整语调。如果你正在写一个入门教程，开个玩笑是可以的，但是如果你在写一个敏感的安全建议，你可能会想要完全避免开玩笑。
惯例和力学¶
- 给读者写信
在提出建议或采取措施时，请将读者描述为 you 或者使用命令语气。
错误：要安装它，用户运行…右：您可以通过运行…右：要安装它，请运行…- 陈述假设
避免做出未声明的假设。在网上阅读意味着指南的任何一页都可能是读者曾经看到的指南的第一页。如果你要做假设，那么说出你要做的假设。
- Cross-reference generously
当您第一次提到工具或实践时，请链接到涵盖该工具或实践的指南部分，或链接到其他地方的相关文档。为读者保存一个搜索。
- 尊重命名惯例
当命名工具、站点、人员和其他专有名词时，请使用它们首选的大写字母。
错误：PIP使用…对：PIP使用…错误：…托管在Github上。右：……在Github上托管。- Use a gender-neutral style
通常，你会直接用 you ， your 和 你的 . 否则，使用中性代词 they ， 他们的 和 他们的 或者完全避免代词。
错误：维护人员上载文件。然后他…对：一个维护人员上传文件。然后他们…对：一个维护人员上传文件。然后维修人员……- 标题
使用读者正在搜索的单词编写标题。这样做的一个好方法是让你的标题完成一个隐含的问题。例如，读者可能想知道 如何安装MyLibrary？ 所以一个好的标题可能是 安装MyLibrary .
在章节标题中，使用句子大小写。换句话说，写标题就像写一个典型的句子一样。
错误：关于python你应该知道的事情对：关于 Python 你应该知道的事情- 数字
在正文中，把数字1到9写成单词。对于表中的其他数字或数字，请使用数字。