编码风格

我们使用 black 代码风格，行长度为 120 个字符，并带有尾随逗号。

您可以使用以下命令格式化代码

black --line-length 120

请为您编写的每个提供者方法添加类型提示。下面概述了通用类型。

您可以在 tox.ini 文件中找到我们完整的 flake8 配置。

当比较变量与 None、False 或 True 时，请使用 is 而不是 ==（参见 https://www.flake8rules.com/rules/E711.html）

if my_var is None:
    ...  # do something

数据集

对于每个数据集，请提供一个注释，说明数据来源和/或出处。如果来源是维基，请同时注明上次检查的日期和时间。

我们只接受来自统计来源（如人口普查或政府机构）的新数据。这包括姓名及其分布。

您可以包含多个来源，但每个姓名都必须来自一个来源。我们不接受完全由贡献者编造的姓名。

姓名列表

当您有很长的姓名列表时，请按字母顺序排列。保持行长度尽可能接近 120 个字符，但不要超过限制。

类型提示

typing.py 包含可在整个代码库中重用的通用类型。此外，一些类型定义包含在代码的其他部分。如果您添加了通用类型，请在下面指定其用法

标题

类型	用途
providers.ElementsType	当在 Provider 中创建变量（例如针对特定区域设置）且未在超类中定义时，self.random_element()、self.random_elements()、self.random_choices() 和 self.random_sample() 假定这是输入格式。
typing.DateParseType	用于解析（相对）日期/时间的各种 faker.providers.date_time 函数的输入。
typing.HueType	色调名称、浮点值或整数范围。
typing.GenderType	只能取值 "F"（女性）和 "M"（男性）的字符串变量

测试

请为所有新的提供者添加测试。

添加新的测试类时，请按字母顺序排列。