跳到正文
GitHub·· 7 天前AI 评分5

maxrionloop/opengptloop 贡献指南:要求 PR 必须通过生产环境验证

maxrionloop/opengptloop

AI 导读

maxrionloop/opengptloop 发布贡献指南,要求所有 Pull Request 在提交前必须达到生产可用标准:代码完整实现、无占位符或 TODO、全部功能经过测试、无构建与运行时错误。PR 需包含变更说明、原因、UI 变更截图或视频及可复现的测试步骤,维护者会拒绝未经验证或降低代码质量的提交。

正文

Contributing Guide

Thank you for your interest in contributing to this project. We welcome high-quality contributions that improve the project while maintaining production standards.

Before You Submit

Every contribution must be production-ready before opening a Pull Request.

Required Checklist

  • ✅ Code is fully implemented (no placeholders, TODOs, or incomplete features).
  • ✅ All existing and new functionality has been thoroughly tested.
  • ✅ No build errors, runtime errors, or console warnings.
  • ✅ Code follows the project's coding style and architecture.
  • ✅ New code does not introduce breaking changes unless explicitly discussed.
  • ✅ Documentation has been updated if behavior or APIs changed.
  • ✅ Unused code, debug logs, and temporary files have been removed.
  • ✅ The project successfully builds and runs in a production environment.

Production Validation

Do not submit code that has not been production validated.

Every Pull Request should be verified by ensuring:

  • The application builds successfully.
  • All tests pass.
  • Features work correctly in a production-like environment.
  • No performance regressions are introduced.

If you cannot verify your changes in a production-ready environment, do not submit the Pull Request.

Pull Request Requirements

Every Pull Request should include:

  • A clear description of the changes.
  • The reason for the change.
  • Screenshots or videos for UI changes (if applicable).
  • Testing steps so reviewers can reproduce the results.

Code Review Policy

Maintainers may reject or request changes for Pull Requests that:

  • Are not production ready.
  • Contain incomplete implementations.
  • Introduce bugs or regressions.
  • Reduce code quality or maintainability.
  • Do not follow the project's architecture or coding standards.

Quality First

We value quality over quantity. A smaller, well-tested contribution is far more valuable than a large, unvalidated one.

By submitting a Pull Request, you confirm that your contribution has been production validated and meets the standards outlined above.

来源:GitHub · github.com