为本指南做出贡献¶
Python Packaging User Guide 欢迎贡献者！有很多方法可以帮助我们，包括：
阅读指南并提供反馈
审查新的贡献
修改现有内容
撰写新内容
翻译该指南
大部分关于 Python Packaging User Guide 的工作都是在 项目的 GitHub 存储库 进行的。要开始工作，请查看 打开议题 和 拉取请求 的列表。如果你打算编写或编辑指南，请阅读 风格指南。
如果您想为 Python Packaging User Guide 作出贡献，您应该遵守 PSF 的 行为准则 。
文档类型¶
本项目由具有特定目的的四种不同的文档类型组成。当提议对项目进行新的补充时，请选择适当的文档类型。
教程¶
教程的重点是通过完成一个目标来教导读者新的概念。它们是有观点的分步指南。它们不包括不相干的警告或信息。示例教程式文档 。
指南¶
指南的重点是完成一项具体的任务，并可以假定有一定程度的前提知识。这类似于教程，但有一个狭窄和明确的重点，并可以根据需要提供大量的注意事项和附加信息。他们还可以讨论完成任务的多种方法。 示例指南式文档。
讨论¶
讨论的重点是理解和信息。这些探索一个特定的主题，没有具体的目标。 示例讨论式文档。
规格¶
规范 (Specifications) 是一种参考文件，侧重于全面记录包装工具之间互操作性的一致接口。 范例规范式文件。
翻译¶
我们使用 Weblate 来管理这个项目的翻译。请访问 Weblate 上的 packaging.python.org 项目，以做出贡献。
如果你在进行翻译工作时遇到问题，请在 Github 上开一个议题。
小技巧
本项目的任何翻译应遵循 reStructuredText 语法。
添加语言¶
如果你的语言没有列在 packaging.python.org 上，请点击语言列表底部的按钮 Start new translation 并添加你要翻译的语言。
遵循 reStructuredText 语法¶
如果你不熟悉 reStructuredText（RST）的语法，请在 Weblate 上进行翻译之前阅读 指南。
不要直接翻译参考文献中的文字
在翻译参考文献的时候，请不要直接翻译它们。
错：直接翻译以下文字：`some ref`_ -> `TRANSLATED TEXT HERE`_对：用你自己的语言翻译以下文字，并添加原始参考资料：`some ref`_ -> `TRANSLATED TEXT HERE <some ref>`_
在本地构建指南¶
虽然这不需要做出贡献，但为了测试您的改动，在本地建立本指南可能是有用的。为了在本地构建本指南，你需要：
Nox 。你可以用
pip来安装或升级 noxpython -m pip install --user nox
Python 3.8. Our build scripts are usually tested with Python 3.8 only. See the Hitchhiker’s Guide to Python installation instructions to install Python 3.8 on your operating system.
To build the guide, run the following shell command in the project’s root folder:
nox -s build
在该过程完成后，您可以在 ./build/html 目录中找到 HTML 输出。您可以打开 index.html 文件，并在浏览器中查看指南，但我们建议使用 HTTP 服务器为指南服务。
您可以使用以下命令建立指南并通过 HTTP 服务器为其提供服务
nox -s preview
该指南将可通过 http://localhost:8000 进行浏览。
指南的部署地点¶
该指南是通过 ReadTheDocs 部署的，配置位于 https://readthedocs.org/projects/python-packaging-user-guide/ 。它由一个自定义域名提供服务，并由 Fast.ly 提供支持。
风格指南¶
本风格指南提供了关于如何编写 Python Packaging User Guide 的建议。在开始写作之前，请先查看它。通过遵循样式指南，您的贡献将有助于增加一个有凝聚力的整体，并使您的贡献更容易被项目接受。
目的¶
Python Packaging User Guide 的目的是成为关于如何使用当前工具打包、发布和安装 Python 项目的权威性资源。
范围¶
该指南旨在通过准确和有针对性的建议来回答问题和解决问题。
本指南并不意味着是全面的，也不意味着可以取代单个项目的文档。例如，pip 有几十个命令、选项和设置。pip 文档详细描述了它们中的每一个，而本指南只描述了完成本指南中描述的特定任务所需的 pip 部分。
读者¶
本指南的受众是任何使用 Python 包的人。
不要忘记，Python 社区是很大，而且很受欢迎的。读者可能与您的年龄、性别、教育、文化等不尽相同，但他们和您一样值得学习包装知识。
特别是要记住，不是所有使用 Python 的人都把自己看作是程序员。本指南的受众包括天文学家，画家或学生以及专业的软件开发人员。
声音和语气¶
在撰写本指南时，即使您已经掌握了所有答案，也要努力以平易近人且谦逊的语气写作。
想象一下，您正在和一个您知道是聪明和熟练的人一起做 Python 项目。您喜欢和他们一起工作，他们也喜欢和您一起工作。那个人问了您一个问题，你知道答案。你怎么回答？这 就是你应该如何写这个指南的方式。
这里有一个快速检查：试着大声朗读以了解您写作的声音和语气。它听起来像您会说的话，还是听起来像您在演戏或发表演讲？随意使用缩略语，不要担心拘泥于繁琐的语法规则。您在此允许用介词来结束一个句子，如果这是您想结束它的话。
在写指南时，根据主题的严肃性和难度调整你的语气。如果你写的是一个介绍性的教程，开个玩笑是可以的，但如果你涉及的是一个敏感的安全建议，你可能要完全避免玩笑。
公约和机制¶
- 写给读者
在提出建议或采取的步骤时，您应称呼读者为 你 或使用命令语气。
错误：要安装它，用户运行…正确：您可以通过运行…来安装它正确：要安装它，请运行…- 陈述假设
避免做出未说明的假设。在网上阅读意味着指南的任何一页都可能是读者所看到的指南的第一页。如果您要做假设，那就要说明您要做什么假设。
- 慷慨地交叉参考
当你第一次提到一个工具或做法时，请链接到指南中涉及它的部分，或链接到其他地方的相关文件。这样可以为读者省去搜索的麻烦。
- 尊重命名的做法
当给工具、网站、人和其他专有名词命名时，请使用它们的首选大写字母。
错误：Pip 使用…正确：pip 使用…错误：…托管在 github 上。正确：……托管在 GitHub 上。- 使用中性风格
通常，您会用 you、your 和 yours 来直接称呼读者。否则，请使用性别中立的代词 they、their 和 theirs ，或者完全避免使用代词。
错误：一个维护人员上传了文件。然后他…正确：一个维护人员上传了文件。然后他们…正确：A maintainer uploads the file. Then the maintainer…- 标题
写标题时要使用读者正在搜索的词。一个好方法是让你的标题完成一个隐含的问题。例如，读者可能想知道 How do I install MyLibrary?，所以一个好的标题可能是 Install MyLibrary 。
在章节标题中，使用句子大小写。换句话说，要像写一个典型的句子那样写标题。
错误：Things You Should Know About Python正确：Things you should know about Python- 数字
在正文中，将数字1到9写成单词。对于其他数字或表格中的数字，使用数字。