检查您的项目,查找贡献者之间常见的摩擦点。
检查您的项目,查找贡献者之间常见的摩擦点。
Flint 会检查您的项目文件夹中是否包含适当的文件和结构,以便潜在的贡献者能够了解: 1) 项目的目标, 2) 如何贡献, 3) 使用指南, 以及 4) 如何安装项目。
如果您已安装 Go,则可以使用 Go 的命令行安装 flint 接口: 去获取 GitHub.com/pengwynn/flint 如果您没有安装 Go,可以下载适合您的 [预构建二进制文件] platform][releases], 可选地将其重命名为 "flint" 以方便使用。
如果您使用 macOS 并使用 [Homebrew] 作为包管理器,则可以使用以下命令安装 flint:
~/projects/dream ❯ flint [ERROR] 未找到 README 文件 [INFO] 每个项目都要有一个 README 文件。http://bit.ly/1dqUYQF [ERROR] 未找到 CONTRIBUTING 指南 [INFO] 为潜在的贡献者添加指南。http://git.io/z-TiGg [ERROR] 未找到 LICENSE 文件 [INFO] 添加许可证以保护自己和用户。http://choosealicense.com/ [WARNING] 未找到 Bootstrap 脚本 [INFO] Bootstrap 脚本可使设置变得简单。http://bit.ly/JZjVL6 [WARNING] 未找到 测试脚本 [INFO] 让人轻松地运行测试套件,无论项目类型如何。http://bit.ly/JZjVL6 [CRITICAL] 发现了一些严重问题。
如果您想检查远程 GitHub 仓库,现在可以不进行克隆就完成此操作:
暂无开放 Issues,或尚未同步最近议题。