为本指南贡献¶
Python 打包用户指南欢迎贡献者！有许多方法可以提供帮助，包括：
阅读指南并提供反馈
审查新贡献
修订现有内容
撰写新内容
翻译指南
Python 打包用户指南的大部分工作都在项目 GitHub 仓库上进行。要开始，请查看开放问题和拉取请求列表。如果您计划编写或编辑指南，请阅读风格指南。
通过为 Python 打包用户指南贡献，您需要遵守 PSF 的行为准则。
文档类型¶
本项目由四种不同目的的文档类型组成。本项目旨在遵循 Diátaxis 流程来创建高质量文档。在向项目建议新添加内容时，请选择合适的文档类型。
教程¶
教程侧重于通过实现一个目标来教授读者新概念。它们是带有明确观点的分步指南。它们不包含无关的警告或信息。示例教程风格文档。
指南¶
指南侧重于完成特定任务，并可以假定读者具备一定的先验知识。这些类似于教程，但具有狭窄而清晰的重点，并且可以根据需要提供大量注意事项和额外信息。它们还可以讨论完成任务的多种方法。示例指南风格文档。
讨论¶
讨论侧重于理解和信息。这些探索特定主题，没有特定的目标。示例讨论风格文档。
规范¶
规范是参考文档，侧重于全面记录包装工具之间互操作性的约定接口。示例规范风格文档。
翻译¶
我们使用Weblate来管理此项目的翻译。请访问 Weblate 上的packaging.python.org项目以贡献。
如果您在翻译过程中遇到问题，请在GitHub上提出问题。
提示
此项目的任何翻译都应遵循reStructuredText 语法。
添加语言¶
如果您的语言未在packaging.python.org上列出，请点击语言列表底部的开始新翻译按钮，并添加您要翻译的语言。
遵循 reStructuredText 语法¶
如果您不熟悉 reStructuredText (RST) 语法，请在 Weblate 上翻译之前阅读本指南。
- 不要直接翻译引用中的文本
翻译引用中的文本时，请不要直接翻译它们。
错误：直接翻译以下文本`some ref`_ -> `TRANSLATED TEXT HERE`_
正确：用您自己的语言翻译以下文本并添加原始引用`some ref`_ -> `TRANSLATED TEXT HERE <some ref>`_
本地构建指南¶
虽然贡献不是必需的，但在本地构建本指南以测试您的更改可能很有用。为了在本地构建本指南，您需要：
Nox。您可以使用
pip安装或升级 nox。python -m pip install --user nox
Python 3.11。我们的构建脚本通常只使用 Python 3.11 进行测试。请参阅《Hitchhiker's Guide to Python》安装说明以在您的操作系统上安装 Python 3.11。
要构建指南，请在项目根文件夹中运行以下 shell 命令：
nox -s build
过程完成后，您可以在./build/html目录中找到 HTML 输出。您可以打开index.html文件以在网络浏览器中查看指南，但建议使用 HTTP 服务器提供指南。
您可以使用以下命令构建指南并通过 HTTP 服务器提供它：
nox -s preview
该指南将可通过https://:8000浏览。
指南部署地点¶
该指南通过 ReadTheDocs 部署，配置位于https://readthedocs.org/projects/python-packaging-user-guide/。它通过自定义域提供服务，并由 Fast.ly 前端。
风格指南¶
本风格指南提供了关于如何编写 Python 打包用户指南的建议。在开始写作之前，请务必审阅。遵循风格指南将有助于您的贡献融入一个连贯的整体，并使您的贡献更容易被项目接受。
目的¶
Python 打包用户指南的目的是成为关于如何使用当前工具打包、发布和安装 Python 项目的权威资源。
范围¶
本指南旨在通过准确且有针对性的建议回答问题并解决问题。
本指南并非旨在全面，也并非旨在取代各个项目的文档。例如，pip 有几十个命令、选项和设置。pip 文档详细描述了它们每一个，而本指南只描述了完成本指南中描述的特定任务所需的 pip 部分。
受众¶
本指南的受众是所有使用带有包的 Python 用户。
不要忘记 Python 社区是庞大而友好的。读者可能与您的年龄、性别、教育背景、文化等方面不同，但他们与您一样有权学习打包。
特别是，请记住并非所有使用 Python 的人都将自己视为程序员。本指南的受众包括天文学家、画家或学生以及专业软件开发人员。
语气和语调¶
在编写本指南时，即使您掌握所有答案，也要努力以平易近人和谦逊的语气写作。
想象一下，您正在与一位您认为聪明且技艺娴熟的人合作一个 Python 项目。您喜欢与他们合作，他们也喜欢与您合作。那个人问了您一个问题，您知道答案。您如何回应？*这就是*您应该编写本指南的方式。
这里有一个快速检查：尝试大声朗读，感受您的写作语气和语调。听起来像您会说的话，还是像在表演或演讲？随意使用缩写，不必担心拘泥于繁琐的语法规则。在此，您被允许以介词结尾句子，如果您想以此结尾的话。
在编写指南时，根据主题的严肃性和难度调整语气。如果您正在撰写入门教程，开个玩笑是可以的，但如果您正在介绍敏感的安全建议，您可能需要完全避免开玩笑。
约定和机制¶
- 写给读者
在给出建议或采取的步骤时，将读者称呼为“您”或使用祈使语气。
错误：要安装它，用户运行……正确：您可以通过运行……来安装它。正确：要安装它，请运行……- 声明假设
避免作出未声明的假设。在网上阅读意味着指南的任何页面都可能是读者第一次看到的页面。如果您要作出假设，那么请说明您将作出哪些假设。
- 慷慨地交叉引用
第一次提及工具或实践时，链接到指南中涵盖它的部分，或链接到其他相关的文档。为读者节省一次搜索。
- 尊重命名惯例
在命名工具、站点、人物和其他专有名词时，请使用它们首选的大小写。
错误：Pip 使用……正确：pip 使用……错误：……托管在 github 上。正确：……托管在 GitHub 上。- 使用中性风格
通常，您会直接以 *you*、*your* 和 *yours* 称呼读者。否则，请使用中性代词 *they*、*their* 和 *theirs*，或完全避免使用代词。
错误：维护者上传文件。然后他……正确：维护者上传文件。然后他们……正确：维护者上传文件。然后维护者……- 标题
编写读者正在搜索的词语的标题。一个好方法是让您的标题完成一个隐含的问题。例如，读者可能想知道“如何安装 MyLibrary？”，因此一个好的标题可能是“安装 MyLibrary”。
在章节标题中，使用句子大小写。换句话说，像写一个普通句子一样写标题。
错误：Things You Should Know About Python正确：Things you should know about Python- 数字
在正文文本中，将一到九的数字写成单词。对于其他数字或表格中的数字，请使用阿拉伯数字。