SuperAPI AI 工具集

contributor-guide

通用与其它

查看项目

更新于 10-16 01:18

技能介绍

用途:为开源项目撰写一份 CONTRIBUTING.md,让潜在贡献者能顺利跑通项目并完成第一次 PR。适合需要补充或重写贡献指南的维护者。

主要能力:生成结构化的贡献指南,涵盖欢迎语、贡献方式(issue、文档、代码、分类整理)、开发环境搭建(克隆、安装、运行、测试的精确命令)、如何找到可做的任务(good first issue / help wanted)、修改流程(分支命名、提交、测试、开 PR)、代码规范(格式化、lint、测试要求、提交与 PR 约定、行为准则链接)、评审与反馈流程、以及求助渠道。

使用方式:技能会先索取必要输入,若未提供则询问:项目与技术栈、开发环境搭建步骤、工作流(分支模型、提交/PR 约定、issue 位置、评审人)、规范(lint/格式化、测试要求、行为准则链接),以及可选的协作惯例(决策方式、响应时间、good-first-issue 流程)。随后输出一份 CONTRIBUTING.md。

质量要求:搭建命令需真实可用并能跑通测试;贡献流程需编号且无歧义(分支→修改→测试→PR);规范需写明并附链接;需指向 good-first-issue 并欢迎非代码贡献;语气鼓励,并明确告知求助位置。

限制:资料未提供具体命令、项目细节或价格信息;实际内容取决于用户提供的项目信息。避免假设贡献者熟悉环境、避免 PR 期望含糊、避免冷漠或守门式语气、避免遗漏求助渠道与评审人、避免忘记行为准则链接。