-
Notifications
You must be signed in to change notification settings - Fork 0
contributing
你可以通过以下方式参与本项目的建设。
提交新的心理学工具。如果你对某一心理学领域有较深的理解，可以基于 know-yourself-system 的规范创建全新的工具，包括 Skill 主文件、知识库文件和配套的题库。
基于其他模型构建完整体系。本项目按模型分目录组织，你可以选择一个尚未覆盖的 AI 模型，将其已有的对话能力与 know-yourself-system 的工具规范结合，构建该模型下的完整心理工具集。
改进现有工具的内容质量。现有工具可能在心理学准确性、交互流畅性或覆盖面上存在不足。你可以修订 Skill 主文件中的角色定义和对话逻辑，补充知识库的内容深度，或完善题库和计分算法的严谨性。
提交问题或建议。如果你发现了 bug、有功能建议或对某个工具的心理学依据存疑，欢迎提交 issue 进行讨论。
在动手之前，建议你先花一些时间熟悉项目的基础设施。
首先通读 know-yourself-system/ 目录下的规范文档，包括工具规范、产物规范、注册规范和构建指南。这些文档定义了整个项目的骨架和约束，所有工具都建立在它们之上。同时留意 templates/ 目录下的模板文件，它们是创建新工具的起点。
然后思考你计划使用的 AI 模型。不同模型在指令遵循能力、上下文窗口大小、角色扮演稳定性等方面存在差异，这些特性会影响你编写 Skill 主文件时的策略。了解模型的边界，才能写出它在实际运行中能够稳定执行的工具。
整个贡献过程可以分为五个步骤。
第一步是选择方向。明确你要做什么——是一个新工具，还是对现有工具的改进。如果是一个新工具，请先确认它尚未存在于项目中，避免重复。
第二步是阅读规范。根据你的工具类型，重点阅读 tool-spec.md 中对应的章节，以及 output-spec.md 中关于产物格式的要求。确保你的理解足够准确后再开始编码。
第三步是创建实现。按照模板创建目录和文件，逐步填充内容。先写 Skill 主文件，再写知识库文件，最后是题库（如果适用）。每一步完成后都回头检查一下是否符合规范。
第四步是验证完整性。对照质量标准逐项检查你的工具是否满足要求。可以用一个 AI 对话窗口加载你的 Skill 文件进行一次模拟运行，看看交互流程是否流畅，模式判断是否覆盖了各种用户输入。
第五步是提交。将成果放入对应 know-yourself-{模型名}/ 目录下的 tools/{工具名}/ 位置。然后更新该目录下的 map.md 文件，在其中注册你的工具信息。
提交的工具有以下几项硬性质量标准。
工具必须有完整的 Skill 主文件和知识库。Skill 主文件是工具的入口，知识库是工具的知识支撑，二者缺一不可。不能只有一个文件而缺失另一个。
评测类工具必须有题库和计分算法。题库是评测的内容基础，计分算法是将原始作答转化为可读结论的逻辑引擎。缺少其中任何一项，评测工具都不具备实际可用性。
交互流程必须符合工具规范中的模式判断标准。工具应该能识别用户是在回答问题、还是在询问概念解释、还是在偏离话题，并针对不同模式做出恰当回应。一个只做线性对话而没有模式感知的工具是不合格的。
产物必须符合产物规范。工具产出的报告、档案或记录必须按照 output-spec.md 中定义的格式输出，包括必要的元信息字段和内容结构。格式不规范的产物会破坏整个项目的数据一致性。
所有参与者都应遵守项目根目录下的 CODE_OF_CONDUCT.md。
尊重他人。协作中保持开放和建设性的态度，对不同的观点和贡献方式持包容态度。
尊重心理学理论来源。工具的心理学内容应基于公认的理论或经过同行评审的研究，而不是个人的主观解读。在知识库中应注明关键概念的理论来源，方便审核者追溯。
不将本项目的工具用于诊断或治疗。know-yourself 的所有工具都是自我探索和认知辅助性质的产品，不能替代专业的心理诊断或心理治疗。在工具的描述和交互中应明确这一点，避免给用户造成误导。
将你的成果放入对应 know-yourself-{模型名}/ 目录下的 tools/{工具名}/ 位置。目录结构应与 tool-spec.md 中定义的层级一致。
在每个 know-yourself-{模型名}/ 目录下都有一个 map.md 文件，它是该模型下所有工具的索引。提交新工具后，需要在该文件中补充工具的名称、类型、简要描述和路径信息。如果 map.md 中已有其他工具，按照相同的格式追加即可。