将2017分类法添加到规则0015
dqc_us_rules的Python项目详细描述
#XBRL美国数据质量委员会规则
< BR>
dqc_us_rules是arelle的插件 < BR>
dqc美国规则包含： < BR>
*XBRL美国数据质量委员会批准公开发布的最终规则
*XBRL美国数据质量委员会批准公开征求公众意见的规则草案
*使用arelle作为xbrl处理器，参考规则的实现
*参考实现的单元测试
*测试套件 < BR>
部署 < BR>
*与arelle一起部署
*将sec目录指定为带有arelle的插件 < BR>
版本控制 < BR>
dqc_us_规则库遵循major.minor.fix格式的标准语义版本控制系统。当一组新的规则在公开评论期之后被dqc批准、编码和接受时，将指定主要版本。 < BR>
每个规则指定的主版本是更改规则的最新版本。例如，被标记为v2.0.0的规则上次在dqc库的2.0.0版本中进行了功能修改。请参阅[规则摘要]（/docs/readme.md）了解当前规则版本的详细信息（也可以在每个规则的代码中找到）（https://github.com/dataqualitycommittee/dqc_us_rule s/search？Q=规则版本）。 < BR>
类似地，对整个规则集进行版本控制。主要版本在每个公开评论期开始时指定，以发布候选颠覆（rc）为后缀，表示在批准版本之前的修订。 < BR>
要求 < BR>
*python 3.x（首选3.4或更高版本）
*1.7吉特+
*c编译器工具链（用于lxml）
*libxml2（也适用于lxml）
*阿雷尔 < BR>
开发 < BR>
强烈建议使用python虚拟环境（如[virtualenv]（http://www.virtualenv.org/en/latest/）进行开发。为了简化虚拟环境的开发和管理，我们建议您查看[virtualenvwrapper]（http://virtualenvwrapper.readthedocs.org/en/latest/）。 < BR>
此设置的其余部分将假定您已安装了[Virtualenv]（http://www.virtualenv.org/en/latest/）和[VirtualenvWrapper]（http://virtualenvWrapper.readthedocs.org/en/latest/）。 < BR>
创建虚拟环境 < BR>
若要创建虚拟环境，请将目录更改为此项目的根目录，然后执行以下命令： < BR>
mkvirtualenv dqc-a$pwd-p<；到python3的路径>； < BR>
这将为您提供一个虚拟环境，您可以通过输入 < BR>
修井DQC < BR>
您需要在其中工作的任何时间。 < BR>
安装依赖项 < BR>
若要安装仅用于开发DQC规则集的依赖项，请使用[PIP]（https://pip.pypa.io/en/latest/installing.html）安装需求。使用以下命令安装开发需求： < BR>
pip安装-r requirements-dev.txt < BR>
运行单元测试 < BR>
要运行单元测试，只需运行包含的shell脚本 < BR>
/运行单元测试.sh < BR>
运行测试套件 < BR>
参见测试套件中的文档 < BR>
规则索引 < BR>
规则定义索引为[此处]（docs/readme.md）。 < BR>
提议的变更 < BR>
我们积极接受并鼓励请求更改代码。下面列出了拉取请求的需求列表，该请求将由项目的技术负责人进行审查。如果请求被接受，它将被合并到相应的分支中。有些请求可能需要委员会的批准，但执行可能需要更长的时间。如果发现请求缺少部分或不完整，将记录有关缺少或不完整部分的注释。 < BR>
"准备好编码"的规则开发： < BR>
当dqc发布已批准编码的新规则时，规则将be在一个名为"next_q_u yy"的分支上开发，其中"_"是季度，"yy"替换为当前年度。所有提议规则的新编码都将以根dataqualitycommittee fork上的此分支为目标。该分支将定期在全局pypi索引上标记并作为发布候选（rc）发布。规则的最终批准完成后，库的rc版本将从索引中删除，下一个分支将合并到master中，并且库的新主版本将在[全局pypi索引]（https://pypi.python.org/simple/dqc us rules/）上发布。 < BR>
拉取请求（pr）的要求： < BR>
-分支离开主分支，在独立分支上开发，pr返回主分支或根分支上的其他适当分支。
-您的代码应该通过[flake8]（https://flake8.readthedocs.org/en/latest/）。
-单元测试覆盖率是必需的，或者解释变更已覆盖或不可覆盖的原因。
-需要良好的[docstrings]（https://github.com/workiva/styleguide/blob/master/python.rst docstrings）。
-需要良好的[提交消息]（http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html）。
-拉取请求必须经过下面描述的审查过程。 < BR>
拉取请求审查流程： < BR>
-每个请求必须至少有一个来自另一个社区成员的"+1"注释。
-要更改代码，必须有第二个社区成员的第二个"+1"注释。
-请求将需要通过下面定义的质量保证过程，并收到"+10"注释。这可以来自任何其他社区成员，包括审阅者之一。
-此时，可以将请求提交给要合并的项目维护者之一。 < BR>
拉取请求的质量保证：
-确认代码在代码和测试中都通过了flake8。
-验证代码是否通过单元测试。
-验证是否添加或更新了测试以反映所做的更改。如果没有添加测试，请检查pull请求中的推理以证明缺席是正确的。
-此模板包含所有步骤，可以用作分步指南。 < BR>
质量保证步骤： < BR>
-手动测试：<；在此处输入手动测试注释。>；
-DQC U U U U U U规则上的第8片：
```
<；将flake8的输出粘贴到此处的dqc\u us_rules目录中。>；
```
-第8片测试：
```
<；将flake8的输出粘贴到此处的测试目录中。>；
```
-鼻测试结果：
```
<；在此处粘贴鼻子测试的输出。>；
``` < BR>
结果：<；将结果放在此处。>； < BR>
结果将是一些事情中的任何一件。例如，a+10表示通过，或者只是一个类似"发回重做"的注释，或者在qa的另一次通过之前需要做的任何事情。 < BR>
许可证 < BR>
有关许可证信息，请参阅[许可证]（https://xbrl.us/dqc-license）。
专利侵权通知见[专利通知]（https://xbrl.us/dqc-patent）。 < BR>
版权所有2015-2017，XBRL US Inc.保留所有权利。
dqc_us_rules是arelle的插件 < BR>
dqc美国规则包含： < BR>
*XBRL美国数据质量委员会批准公开发布的最终规则
*XBRL美国数据质量委员会批准公开征求公众意见的规则草案
*使用arelle作为xbrl处理器，参考规则的实现
*参考实现的单元测试
*测试套件 < BR>
部署 < BR>
*与arelle一起部署
*将sec目录指定为带有arelle的插件 < BR>
版本控制 < BR>
dqc_us_规则库遵循major.minor.fix格式的标准语义版本控制系统。当一组新的规则在公开评论期之后被dqc批准、编码和接受时，将指定主要版本。 < BR>
每个规则指定的主版本是更改规则的最新版本。例如，被标记为v2.0.0的规则上次在dqc库的2.0.0版本中进行了功能修改。请参阅[规则摘要]（/docs/readme.md）了解当前规则版本的详细信息（也可以在每个规则的代码中找到）（https://github.com/dataqualitycommittee/dqc_us_rule s/search？Q=规则版本）。 < BR>
类似地，对整个规则集进行版本控制。主要版本在每个公开评论期开始时指定，以发布候选颠覆（rc）为后缀，表示在批准版本之前的修订。 < BR>
要求 < BR>
*python 3.x（首选3.4或更高版本）
*1.7吉特+
*c编译器工具链（用于lxml）
*libxml2（也适用于lxml）
*阿雷尔 < BR>
开发 < BR>
强烈建议使用python虚拟环境（如[virtualenv]（http://www.virtualenv.org/en/latest/）进行开发。为了简化虚拟环境的开发和管理，我们建议您查看[virtualenvwrapper]（http://virtualenvwrapper.readthedocs.org/en/latest/）。 < BR>
此设置的其余部分将假定您已安装了[Virtualenv]（http://www.virtualenv.org/en/latest/）和[VirtualenvWrapper]（http://virtualenvWrapper.readthedocs.org/en/latest/）。 < BR>
创建虚拟环境 < BR>
若要创建虚拟环境，请将目录更改为此项目的根目录，然后执行以下命令： < BR>
mkvirtualenv dqc-a$pwd-p<；到python3的路径>； < BR>
这将为您提供一个虚拟环境，您可以通过输入 < BR>
修井DQC < BR>
您需要在其中工作的任何时间。 < BR>
安装依赖项 < BR>
若要安装仅用于开发DQC规则集的依赖项，请使用[PIP]（https://pip.pypa.io/en/latest/installing.html）安装需求。使用以下命令安装开发需求： < BR>
pip安装-r requirements-dev.txt < BR>
运行单元测试 < BR>
要运行单元测试，只需运行包含的shell脚本 < BR>
/运行单元测试.sh < BR>
运行测试套件 < BR>
参见测试套件中的文档 < BR>
规则索引 < BR>
规则定义索引为[此处]（docs/readme.md）。 < BR>
提议的变更 < BR>
我们积极接受并鼓励请求更改代码。下面列出了拉取请求的需求列表，该请求将由项目的技术负责人进行审查。如果请求被接受，它将被合并到相应的分支中。有些请求可能需要委员会的批准，但执行可能需要更长的时间。如果发现请求缺少部分或不完整，将记录有关缺少或不完整部分的注释。 < BR>
"准备好编码"的规则开发： < BR>
当dqc发布已批准编码的新规则时，规则将be在一个名为"next_q_u yy"的分支上开发，其中"_"是季度，"yy"替换为当前年度。所有提议规则的新编码都将以根dataqualitycommittee fork上的此分支为目标。该分支将定期在全局pypi索引上标记并作为发布候选（rc）发布。规则的最终批准完成后，库的rc版本将从索引中删除，下一个分支将合并到master中，并且库的新主版本将在[全局pypi索引]（https://pypi.python.org/simple/dqc us rules/）上发布。 < BR>
拉取请求（pr）的要求： < BR>
-分支离开主分支，在独立分支上开发，pr返回主分支或根分支上的其他适当分支。
-您的代码应该通过[flake8]（https://flake8.readthedocs.org/en/latest/）。
-单元测试覆盖率是必需的，或者解释变更已覆盖或不可覆盖的原因。
-需要良好的[docstrings]（https://github.com/workiva/styleguide/blob/master/python.rst docstrings）。
-需要良好的[提交消息]（http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html）。
-拉取请求必须经过下面描述的审查过程。 < BR>
拉取请求审查流程： < BR>
-每个请求必须至少有一个来自另一个社区成员的"+1"注释。
-要更改代码，必须有第二个社区成员的第二个"+1"注释。
-请求将需要通过下面定义的质量保证过程，并收到"+10"注释。这可以来自任何其他社区成员，包括审阅者之一。
-此时，可以将请求提交给要合并的项目维护者之一。 < BR>
拉取请求的质量保证：
-确认代码在代码和测试中都通过了flake8。
-验证代码是否通过单元测试。
-验证是否添加或更新了测试以反映所做的更改。如果没有添加测试，请检查pull请求中的推理以证明缺席是正确的。
-此模板包含所有步骤，可以用作分步指南。 < BR>
质量保证步骤： < BR>
-手动测试：<；在此处输入手动测试注释。>；
-DQC U U U U U U规则上的第8片：
```
<；将flake8的输出粘贴到此处的dqc\u us_rules目录中。>；
```
-第8片测试：
```
<；将flake8的输出粘贴到此处的测试目录中。>；
```
-鼻测试结果：
```
<；在此处粘贴鼻子测试的输出。>；
``` < BR>
结果：<；将结果放在此处。>； < BR>
结果将是一些事情中的任何一件。例如，a+10表示通过，或者只是一个类似"发回重做"的注释，或者在qa的另一次通过之前需要做的任何事情。 < BR>
许可证 < BR>
有关许可证信息，请参阅[许可证]（https://xbrl.us/dqc-license）。
专利侵权通知见[专利通知]（https://xbrl.us/dqc-patent）。 < BR>
版权所有2015-2017，XBRL US Inc.保留所有权利。
欢迎加入QQ群-->： 979659372
