README

该检查工具用于项目所有者衡量他们的开源项目是否对贡献者友好。

简介

wospm-checker 是一个命令行工具，用于衡量开源项目对用户和潜在贡献者的友好程度。该工具会将仓库与一系列指标进行比较。这些指标大多受 GitHub 开源指南的启发。

如何安装和使用

使用 composer 安装此包。

composer global require wospm/checker

您可以使用 --help 参数查看命令的选项和其他信息。

wospm-checker --help

WOSPM Checker version: 0.0.1
Options:
    --output            The format of output. JSON, READABLE (Default), NO, HTML.
    --verbose           Show the progress or not. (0 => No, 1 => Detailed,
                        2 => Dots)
    --no-colors         Disable the console colors. It is enabled by default.
    --strict            Enable strict mode. The script will have a higher
                        bound to give success code.
    --version           Show version.
    --help              Print this help.

您可以在仓库根目录下运行 wospm-checker 命令来检查您的项目。

/full/path/to/wospm-checker

Github Action

它也作为名为 "WOSPM Checker Github Action" 的操作在 GitHub 市场准备好，可用于您的流水线。

需要考虑的事项

GitHub Rest API 速率限制 ❗❗❗

wospm-checker 使用 GitHub Rest API 在某些指标检查中获取仓库信息。使用此 API 存在一些限制。当您频繁使用 wospm-checker 时，可能会遇到 API 匿名限制的瓶颈。

Client error: `GET https://api.github.com/repos/user/repo/labels` resulted in a `403 Forbidden` response:
{
  "message": "API rate limit exceeded for XX.XX.XX.XXX. (But here's the good news: Authenticated requests get a higher (truncated...)

您可以使用您的个人访问令牌来获得更大的速率限制。为了做到这一点，您需要在要检查的仓库根目录下创建一个名为 .wospm 的 YML 文件。

github:
    auth_token: PERSONAL_ACCESS_TOKEN

WOSPM度量

WOSPM 度量是用来对开源项目是否对贡献者友好进行定量评估的指标。它们不是科学值，大多来自 Open Source Guides。

度量规则

每个指标应只检查一个简单的案例
指标可以相互依赖（如果没有 README，则不需要检查 README 内容等。）
每个指标应有一个唯一的 WOSPMXXX 编号和一个唯一的标题（大写和蛇形）。

有关向项目添加新指标的信息，请参阅添加新指标部分。

现有度量列表

要查看指标详情，请点击指标代码查看详细文档。

徽章

检查后，检查器将为项目生成一个总体状态。以下是一些考虑的状态类型；

完美：这意味着项目涵盖了 100% 的指标。
友好：这意味着项目至少涵盖了 90% 的指标。
未准备就绪： 这表示项目尚未准备好被接受为欢迎状态。项目覆盖了50%到90%的指标。
差：表示项目处于非常糟糕的状态。覆盖率低于50%。

检查器在执行结束时生成项目的徽章代码。

贡献

有关信息，请参阅CONTRIBUTING.md。

行为准则

有关信息，请参阅CODE_OF_CONDUCT。

贡献者 ✨

感谢这些杰出的人物（emoji key）

由all-contributors。

欢迎各种类型的贡献！

wospm / checker

维护者

详情