Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
61 lines (36 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 2.59 KB

贡献指南 / Contributing Guide

感谢你对 scriptorium 的兴趣！以下是参与贡献的方式。

Thank you for your interest in scriptorium! Here's how to contribute.

贡献方式 / Ways to Contribute

1. 🐛 报告问题 / Report Issues

发现框架设计中的问题、歧义或错误？提交 Issue

Found a problem, ambiguity, or error in the framework? Open an Issue

2. 💡 提议新功能 / Suggest Features

有更好的 Agent 设计、新的工作流阶段或改进想法？提交功能建议

Have ideas for better agent designs, new workflow phases, or improvements? Open a Feature Request

3. 🌍 翻译文档 / Translate Docs

帮助将框架文档翻译为其他语言（英文、日文、繁体中文等）。详见 i18n/ 目录（待创建）。

Help translate framework documentation into other languages (English, Japanese, Traditional Chinese, etc.).

4. 📚 分享你的项目 / Share Your Project

用本框架写了书？告诉社区！

Used this framework to write a book? Tell the community!

5. 🔧 改进模板 / Improve Templates

对 templates/ 目录中的模板有改进建议？直接提 PR！

Have improvements for templates in the templates/ directory? Submit a PR directly!

PR 规范 / PR Guidelines

  • 保持框架的通用性——不要加入特定项目的内容
  • Agent 提示词设计应与具体 LLM 厂商无关（不写死 Claude/GPT）
  • 文档改动请同步更新对应的多语言版本（如有）
  • 每个 PR 只做一件事

Keep the framework generic. Agent prompt designs should be LLM-agnostic. Each PR should do one thing.

不接受的贡献 / Out of Scope

  • 特定书籍项目的内容（书稿、章节草稿）
  • 特定 LLM API 的集成代码
  • 与多 Agent 技术书写作无关的功能

行为准则 / Code of Conduct

本项目遵循 Contributor Covenant v2.1。请友善对待每一位社区成员。

This project follows the Contributor Covenant v2.1.