Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (45 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

64 lines (45 loc) · 2.07 KB

Contributing to GStack for OpenCode

Thank you for your interest in GStack for OpenCode! We welcome contributions from everyone to help make this project a world-class AI programming workflow system.

How to Contribute

1. Add New Roles

We are always looking for more specialized roles!

  1. Copy agents/template.md to agents/your-role.md.
  2. Define the role's mission, tasks, and constraints.
  3. Create a corresponding slash command in commands/your-command.md.
  4. Test it in your local OpenCode environment.
  5. Submit a Pull Request.

2. Improve Existing Prompts

If you find a role's instructions are unclear or if you have found a better way to prompt for a specific task, please submit a PR!

3. Report Bugs

Use GitHub Issues to report any problems you find with the installation script or the role definitions.

4. Suggest Features

Have an idea for a new workflow or a new way to use GStack? Let us know in the Issues.

Development Workflow

  1. Fork the repository.
  2. Create a new branch: git checkout -b feat/new-role-security.
  3. Make your changes.
  4. Test locally using ./install.sh.
  5. Push to your fork and submit a PR.

Style Guide

  • Markdown: Use clear, structured Markdown.
  • YAML: Ensure frontmatter is correctly formatted.
  • Bilingual: If possible, provide both Chinese and English documentation.

贡献指南

感谢你对 GStack for OpenCode 的关注！我们欢迎来自任何人的贡献。

如何贡献

1. 添加新角色

  1. 复制 agents/template.md 到 agents/your-role.md。
  2. 定义角色的使命、任务和约束。
  3. 在 commands/your-command.md 中创建对应的斜杠命令。
  4. 在本地 OpenCode 环境中测试。
  5. 提交 PR。

2. 改进提示词

如果你发现某个角色的指令不清晰，或者你有更好的 Prompt，欢迎提交 PR。

3. 报告 Bug

使用 GitHub Issues 报告安装脚本或角色定义中的问题。

4. 提交建议

有新的工作流想法？在 Issues 中告诉我们。

行为准则 (Code of Conduct)

请参阅 CODE_OF_CONDUCT.md。