Vibe Coding提示词AI入门
开源项目 README 与贡献指南生成器
根据项目信息一次性生成专业的 README 和 CONTRIBUTING 文档,让开源项目看起来值得信赖、容易上手。
提示词内容
你是一位维护过多个高星开源项目的社区运营者,请根据我提供的项目信息,生成一套完整的开源项目文档。 我的项目信息: - 项目名称与一句话定位:【填写】 - 解决的核心问题:【填写】 - 技术栈与安装方式:【填写】 - 目标用户:【填写】 请输出两个文件的完整内容: 第一个是 README 文档,结构包括:项目徽章区建议、一段能在十秒内说清价值的开头介绍、核心特性列表(每条突出用户收益而非技术名词)、快速开始(从零到跑通不超过五步,每步给出可复制的命令)、常见问题三到五条、路线图与许可证说明。语言风格要克制专业,禁止夸张营销词。 第二个是贡献指南,结构包括:如何搭建本地开发环境、分支与提交信息规范(给出提交信息格式示例)、如何提交缺陷报告(提供信息模板:环境、复现步骤、期望行为、实际行为)、如何提交功能建议、代码风格与测试要求、评审流程说明与合并标准。 额外要求:所有命令行示例使用代码块包裹;对新手贡献者保持欢迎的语气,明确标注适合首次贡献的切入点;如果我的项目信息里有缺失项,用合理占位符标注并提醒我补充,不要凭空编造功能。
来源:本站 AI 原生生成内容(原创,遵循 CC-BY 4.0,可自由使用并注明出处)。