XFusion

贡献指南 ​

作者

ccb5

非常感谢您对 XFusion 作出贡献！xfusion 在 Apache-2.0 开源许可证下开源。

本文说明如何对 XFusion 作出贡献。

准备工作 ​

提交 Pull Request(以下简称 PR) 前，请检查以下条目：

  • 许可证：

    • 如果提交的代码不是您从零开始写的，请检查是否与兼容 XFusion 的开源许可证？xfusion 只接受兼容 Apache-2.0 许可证的代码。
    • 如果您是公司的雇员，通常您代码的版权属于公司，因此这意味着您提交代码前必须获得公司的授权，并提交相应的许可协议。

  • PR 提交步骤：

    • 做任何重要的贡献之前，请检查 issue 中是否有相关讨论，或者提出 issue 询问想法，避免浪费您的精力。
    • 请参考PR 提交步骤。

  • 代码风格：

  • 代码注释：

    • 是否符合 XFusion 的代码注释指南？
    • 代码必要的注释是否充分？
    • 注释描述是否明确无歧义？
    • 是否注明了注意事项？

  • 说明文档：

    • 如果贡献的是较大的功能块，是否提供了符合 XFusion 的说明文档指南的说明文档或者使用说明？

  • 签署 CLA： 如果您是第一次向 XFusion 贡献代码，则需要在 PR 页面签署 Contributor License Agreement(CLA)。

子文档 ​