SuperAPI AI 工具集

jan-project-standard

编程与开发

查看项目

更新于 11-03 16:15

技能介绍

用途:该技能用于按 Jan Polanco Velasco 的约定创建或标准化个人与学术项目,把可重复、可复现、可审计的项目治理方式应用到仓库中。核心理念是项目文件夹内的一切都有书面指令,而 CONSTITUTION.md 是唯一事实来源:健康项目应能让代理或人阅读该文件后无需猜测即可操作。

主要能力:技能提供项目脚手架脚本 new_project.py,可用参数指定项目名称、路径、仓库名、所有者、描述、作者与邮箱、Python 版本等,生成标准文件;支持应用模式(--app)、精简模式(--minimal)、可选 Archify 架构章节、省略类型检查、跳过 GitHub 或代理文件、git 初始化、完成后同步环境、覆盖、干跑与仅审计等选项。审计模式(--audit)在不写入的情况下读取 pyproject.toml、.python-version、CONSTITUTION.md 和 git 远程,报告 FALTA/DIFIERE/OK。另有 setup_git_identity.py 用于按目录配置 Git 身份与 SSH 密钥。

使用方式:以自然语言描述案例并附加 @jan-project-standard,说明是否为 Jan、项目状态、仓库地址、技术栈、目标与约束。新建项目时运行脚手架命令,补充 CONSTITUTION.md 中标记的部分,执行 uv sync、安装 pre-commit、运行 make check,再连接 GitHub 并保护 main 分支。改进现有项目时先审计,阅读现有 README、CONSTITUTION.md 与结构,提出计划后以增量方式应用,不盲目使用 --force,需要时手动合并差异并记录到宪法历史。

标准约定:CONSTITUTION.md 优先并在架构或流程变更的同一提交中更新;仅用 uv 管理环境与依赖,禁止 pip 与 requirements.txt;Python 3.13+ 固定在 .python-version 与 requires-python;默认 src-layout 与 uv_build;Ruff、pre-commit、pytest 自动化质量检查,make check 未通过不得提交;Makefile 作为命令接口并与 CI 保持一致;使用 Conventional Commits;GitHub 仓库配置 PR 与 issue 模板、CI、Dependabot、标签与受保护 main;README 包含徽章、目录、技术栈、快速开始、结构与许可;Git 身份通过 includeIf 按目录自动继承。

适用场景:从零创建仓库、标准化现有项目、编写或更新 CONSTITUTION.md、配置 uv/Ruff/pre-commit/Makefile/CI、连接本地项目到 GitHub、准备专业 README、按需生成 Archify 架构图或配置 Git 身份。

限制:不适用于已有自身标准且用户不愿采用该标准的项目,也不适用于已标准化仓库的一行小改动。现有项目中不得未审阅就替换用户文件;默认许可证为 MIT,其他收费、价格或平台支持信息暂未提供。