pr-compliance-action 的项目扩展与二次开发

项目的基础介绍

pr-compliance-action 是一个开源的 GitHub Actions 项目，旨在帮助维护代码库的 PR（Pull Request）合规性。该工具会检查 PR 的标题、描述、来源分支以及所修改的文件是否符合预设的规范，以确保代码提交的质量和一致性。

项目核心功能

• 标题格式检查：根据约定式提交（conventional commits）规则检查 PR 标题格式。
• 问题描述检查：检查 PR 主体是否引用了一个问题，通过正则表达式匹配。
• 分支检查：确保 PR 不是从受保护的分支发起。
• 文件修改检查：检查 PR 是否包含对特定文件的修改，例如 package.json。

项目使用了哪些框架或库？

该项目主要使用了以下框架或库：

• TypeScript：用于编写项目的核心逻辑。
• GitHub Actions：用于构建自动化工作流程。
• @actions/core：GitHub Actions 核心库，用于处理输入输出等。
• jest：用于单元测试。

项目的代码目录及介绍

项目的代码目录如下：

• src/：包含项目的核心代码。
• dist/：编译后的 JavaScript 文件。
• tests/：单元测试代码。
• .github/：包含 GitHub Actions 工作流配置文件。
• README.md：项目说明文档。
• LICENSE：项目许可证文件。

对项目进行扩展或者二次开发的方向

1. 增加自定义规则：允许用户自定义更多的合规性检查规则，如代码风格、代码复杂度等。
2. 集成其他工具：整合静态代码分析工具，如 ESLint、Prettier 等，以提供更全面的代码质量检查。
3. 多语言支持：扩展项目以支持其他语言的提交格式，如 Python、Java 等。
4. 交互式反馈：改进 PR 评论的交互性，提供更详细的合规性问题说明和修复建议。
5. 插件系统：开发插件系统，允许社区贡献者开发和使用自定义的合规性检查插件。