Skip to content

Latest commit

 

History

History
129 lines (84 loc) · 7.11 KB

File metadata and controls

129 lines (84 loc) · 7.11 KB

awesome-novel-skill 项目贡献说明

1. 项目简介

awesome-novel-skill 是一款免费开源的 AI 小说创作助手工具,基于 DeepSeek TUI、Claude Code、Hermes、OpenClaw 等 AI 终端工具运行,遵循 GPLv3 开源协议。项目旨在降低小说创作门槛,为创作者提供世界观搭建、角色塑造、章节大纲、正文撰写、文风优化、伏笔追踪等一站式小说创作能力,个人用户永久免费使用,商业使用需获得作者官方授权。

本项目依靠社区驱动维护,欢迎各类技术人员、网文创作者、爱好者参与贡献,无需高深编程能力,文案优化、素材补充、bug 反馈均为有效贡献方式。

2. 贡献前置规范

2.1 开源协议要求

  • 所有代码、文档、配置文件的提交均遵循 GPLv3 协议,提交即代表同意开源协议条款;
  • 禁止提交闭源、侵权、违规的第三方资源,不得上传无版权的小说素材、商用文案;
  • 个人修改版本可自用,二次分发、衍生改版需遵守开源协议,保留项目原始版权声明。

2.2 基础提交准则

  • 所有提交内容需贴合项目定位:专注小说 AI 辅助创作,不新增无关功能、冗余插件;
  • 代码、文档命名规范,注释通俗易懂,适配国内用户使用习惯;
  • 提交前自行测试,保证功能无破坏性 bug,兼容 DeepSeek TUI 等主流适配终端。

3. 贡献方式(全人群适配)

3.1 非技术向贡献(无编程基础)

3.1.1 问题反馈与 BUG 提交

作为项目使用者,你是最容易发现问题的群体,可在 GitHub Issues 提交反馈,包含以下类型问题:

  • 功能异常:安装脚本报错、章节归档失败、角色状态记录异常;
  • 生成缺陷:AI 文笔生硬、去 AI 味效果差、伏笔追踪失效、节奏检测失灵;
  • 适配问题:终端版本兼容故障、不同系统(Windows/Linux)安装异常。

提交要求:清晰描述操作步骤、报错现象、使用的终端工具(DeepSeek TUI/Claude Code 等),附带截图、日志更佳,方便复现排查。

3.1.2 素材与模板扩充

  • 题材档案:补充仙侠、都市、悬疑、科幻、奇幻等网文题材人设、叙事模板、章节框架;
  • 文风素材:优化文风分析规则,补充主流网文作者文风特征库;
  • 提示词优化:优化章节生成、人设塑造、剧情推演的内置提示词,降低 AI 机械感。

3.1.3 文档优化与翻译

  • 优化官方文档:完善新手安装教程、操作指令说明、高阶使用玩法,简化零基础用户操作指引;
  • 补充使用案例:新增修仙、都市等小说实操案例,丰富 docs 文档内教学内容;
  • 文案润色:优化 README、SKILL.md 描述文案,通俗易懂,适配国内网文创作者。

3.1.4 资金贡献

本项目坚持非商业化运营,所有功能对个人用户永久免费。如您认可本项目的价值,可以通过以下方式支持项目持续发展:

  • GitHub Sponsors:通过 GitHub Sponsors 计划定期资助项目维护
  • 爱发电:在爱发电平台为项目提供资金支持
  • Ko-fi:通过 Ko-fi 平台一次性赞助项目开发

资金将用于:服务器费用、AI API 调用补贴、开源许可证采购、开发者激励等。所有资金使用情况将在项目社区定期公开。

3.1.5 推广贡献

  • 在社交平台、创作社群分享项目,帮助更多网文创作者免费使用 AI 写作工具;
  • 撰写项目评测、教程、使用心得,在博客、CSDN、知乎等平台发布;
  • 为新手用户解答安装、指令使用、项目迁移等基础问题,维护社区交流环境;
  • 制作视频教程、操作演示,发布至 B 站、YouTube 等视频平台;
  • 翻译项目文档至其他语言,帮助海外创作者了解和使用本工具。

3.2 技术向贡献(具备编程基础)

3.2.1 代码开发与优化

  • 脚本优化:迭代 install.sh、install.ps1 安装脚本,修复安装报错、优化安装流程;
  • 功能迭代:优化 7-agent 协作流程、SOLO 全自动模式,完善 agent 定义和 skill SOP;
  • 兼容性适配:适配更多 AI 终端工具,优化 DeepSeek TUI 兼容性,移除冗余模型依赖;
  • 算法优化:升级 AI 去机器腔检测、伏笔钩子追踪、剧情节奏检测算法。

3.2.2 代码审核与维护

  • 审核社区提交的 Pull Request(PR),校验代码安全性、兼容性、逻辑性;
  • 清理冗余文件,优化项目目录结构,删减无用脚本、参考文件;
  • 维护 GitHub Actions 自动化部署,优化 GitHub Pages 部署流程。

3.2.3 周边生态开发

  • 拓展衍生工具:开发小说项目迁移工具、文风分析可视化工具;
  • 优化资源目录:完善 agents/(agent 定义)、knowledge/(格式规范)、memory/(反 AI 规则),拓展辅助创作功能。

4. 提交规范

4.1 Issues 提交规范

  • 标签分类:Bug 反馈、功能建议、素材补充、文档优化;
  • 标题简洁直白,正文清晰描述需求、问题、优化方案,避免无意义灌水;
  • 重复问题请不要重复提交,可在原有 Issues 下追加评论补充信息。

4.2 Pull Request 提交规范

  • 分支要求:基于项目主分支新建开发分支,禁止直接修改 main 主分支;
  • 提交备注:严格遵循项目提交注释格式,示例:fix: 修复 Windows 安装路径报错docs: 新增都市题材创作案例
  • 测试要求:提交前在至少一种 AI 终端完成功能测试,保证无破坏性 bug;
  • 内容限制:单次 PR 聚焦单一功能优化/修复,禁止批量杂乱修改。

5. 项目分支与版本说明

分支 说明
main 稳定发布分支,存放正式可用版本,仅合并审核通过的完善代码
开发分支 用于迭代测试,新增功能、代码优化优先提交至开发分支,测试无误后合并至主分支
  • 版本迁移:项目支持旧版一键迁移至 4.0 版本,贡献者需保证迁移逻辑兼容历史项目数据,保留用户创作备份。

6. 禁止行为

  • 禁止提交恶意代码、病毒脚本、违规侵权资源;
  • 禁止篡改项目开源协议、版权声明,禁止私自将项目改为闭源商用;
  • 禁止恶意刷提交、无意义修改文件、灌水 Issues 和 PR;
  • 禁止利用本项目制作违法、低俗、违规小说内容。

7. 联系方式与授权说明

类型 说明
个人使用 所有功能永久免费,无订阅、无 API 费用
商业使用 必须联系项目作者获取官方授权,严禁无授权商用
贡献交流 可在 GitHub 仓库提交 Issues、PR 进行沟通,项目维护人员会定期审核回复
版权声明 本项目基于 GPLv3 开源,衍生作品需同等开源并标注原项目来源

8. 致谢

感谢所有开源贡献者、网文创作者的无私付出;感谢 DeepSeek TUI 项目提供免费终端运行环境;项目部分设计灵感源自 InkOS,在此对相关开发者致以诚挚感谢。