开源项目最佳实践的自动检查表。
open-project-linter的Python项目详细描述
#open project linter是一个自动化的清单,新的(或有经验但健忘的)开源维护人员可以使用它来确保他们在文档、代码中使用良好的实践。以及项目资源。
项目开始时是为了自动化
[编辑室开发人员的检查表](https://docs.google.com/document/d/1kthagzlyteodmia1jmigbkjgugxkmzfxowegdku qu/edit),
但这些都是大多数开源项目的好做法!
这是在python 3中编写并支持的。
有关更多信息,
[虚拟环境教程](http://docs.python guide.org/en/latest/dev/virtualenvs/)。
一旦您设置了python3虚拟环境,激活环境。
然后您可以使用pip安装open project linter。
````
$pip安装open project linter
```
安装包后,您应该能够从
命令行运行它(请参阅[示例用法](“示例用法”)。
如果要检查本地存储库,
请确保虚拟环境已激活并运行:
```
$open linter-d path/to/repository/
```
要获得更多帮助,请运行`$openlinter--help`.
检查你想确定的文件名是否存在。默认配置文件位于
`path/to/openlinter/rules.yml`.
像这样:
```
$openlinter-r path/to/rules.yml-d path/to/repository/
```
使用位于“path/to/rules.yml”的文件检查位于
`path/to/repository/`.
然后使用“git clone”将其克隆到
开发机器上。
reflog
不是提交历史记录([30](https://github.com/opennewslabs/open project linter/issues/30))
linter逻辑输出到函数中并改进模块
文档
*为与git相关的测试添加测试夹具([22](https://github.com/opennewslabs/open project linter/issues/22))
有或没有从'requirements.txt'
*中提取版本,现在在包中包含'rules.yml',并使用正确的默认路径
文件内容检查器:BR/> BR/>版本0.1DEV
*命令行应用程序可使用“OpenLITER”,在
帮助下如何运行它:BR/> *给定路径的目录,检查:< BR/> *许可证的存在,贡献,以及自述文件
*目录和任何子目录中存在代码文件
*Git存储库、多个分支、任何分支上的多个提交以及命名的开发/功能分支
*c可通过“rules.yml”配置
changeset consulting的sumana harihareswara参加了最初的[opennews](http s://opennews.org/)文档sprint,[the field guide to open source in the newsroom](http://fieldguide.opennews.org/)并建议开发一个配套的工具来尽可能地自动化指南的清单。
社区添加了新的linter规则以帮助新的维护人员。
项目开始时是为了自动化
[编辑室开发人员的检查表](https://docs.google.com/document/d/1kthagzlyteodmia1jmigbkjgugxkmzfxowegdku qu/edit),
但这些都是大多数开源项目的好做法!
这是在python 3中编写并支持的。
有关更多信息,
[虚拟环境教程](http://docs.python guide.org/en/latest/dev/virtualenvs/)。
一旦您设置了python3虚拟环境,激活环境。
然后您可以使用pip安装open project linter。
````
$pip安装open project linter
```
安装包后,您应该能够从
命令行运行它(请参阅[示例用法](“示例用法”)。
如果要检查本地存储库,
请确保虚拟环境已激活并运行:
```
$open linter-d path/to/repository/
```
要获得更多帮助,请运行`$openlinter--help`.
检查你想确定的文件名是否存在。默认配置文件位于
`path/to/openlinter/rules.yml`.
像这样:
```
$openlinter-r path/to/rules.yml-d path/to/repository/
```
使用位于“path/to/rules.yml”的文件检查位于
`path/to/repository/`.
然后使用“git clone”将其克隆到
开发机器上。
reflog
不是提交历史记录([30](https://github.com/opennewslabs/open project linter/issues/30))
linter逻辑输出到函数中并改进模块
文档
*为与git相关的测试添加测试夹具([22](https://github.com/opennewslabs/open project linter/issues/22))
有或没有从'requirements.txt'
*中提取版本,现在在包中包含'rules.yml',并使用正确的默认路径
文件内容检查器:BR/> BR/>版本0.1DEV
*命令行应用程序可使用“OpenLITER”,在
帮助下如何运行它:BR/> *给定路径的目录,检查:< BR/> *许可证的存在,贡献,以及自述文件
*目录和任何子目录中存在代码文件
*Git存储库、多个分支、任何分支上的多个提交以及命名的开发/功能分支
*c可通过“rules.yml”配置
changeset consulting的sumana harihareswara参加了最初的[opennews](http s://opennews.org/)文档sprint,[the field guide to open source in the newsroom](http://fieldguide.opennews.org/)并建议开发一个配套的工具来尽可能地自动化指南的清单。
社区添加了新的linter规则以帮助新的维护人员。