Skip to content

Latest commit

 

History

History
64 lines (44 loc) · 2.21 KB

File metadata and controls

64 lines (44 loc) · 2.21 KB

Contributing

Thanks for your interest in improving this repository.

This project is a public playbook for AI-assisted development workflows. Contributions should preserve that direction: clarity first, composability second, novelty last.

What this repository values

  • clear ownership boundaries
  • durable documentation over prompt clutter
  • reusable templates over private environment assumptions
  • bilingual parity where practical
  • evidence-backed guidance over workflow hype

Contribution principles

When contributing to this repo, prefer changes that make the workflow:

  • easier to understand
  • easier to adopt in another environment
  • less ambiguous in ownership and routing
  • more maintainable over time

Recommended contribution flow

  1. Start from the README and relevant docs before changing structure.
  2. Keep English and Simplified Chinese docs reasonably aligned.
  3. If you change lifecycle semantics, update the relevant command templates and AGENTS.template.md. The legacy routing and self-check templates are historical references, not required sync targets.
  4. If you change templates, explain what the consumer is expected to customize.
  5. Prefer small, focused pull requests.

What is in scope

  • README and docs improvements
  • architecture clarifications
  • setup and template guidance
  • prompt examples and glossary updates
  • contributor experience improvements

What is not in scope yet

  • screenshots or heavy visual assets without a stable story
  • speculative integrations that are not used in the documented stack

Pull request expectations

Good pull requests for this repo usually:

  • explain why the change improves the playbook
  • keep documentation structure clean
  • avoid introducing duplicate workflow authority
  • preserve or improve bilingual parity
  • distinguish clearly between transferable methodology and OpenCode-specific implementation

Questions to ask before opening a PR

  • Does this change clarify the stack or make it more confusing?
  • Does it keep one primary owner per task?
  • Does it improve adoption for future readers?
  • Does it encode a real practice rather than a temporary preference?

Communication

When in doubt, prefer an issue or discussion first for structural changes.