提交自己的代码

Estimated reading time: 2 minutes
温馨提示

若您没有Github 账号,您可以加入我们的TG 交流群

DANGER

本页面不适合非开发者阅读。

WARNING

本页面默认您电脑中拥有KotlinAndroid开发环境。

一般步骤

  • Fork 分支
  • 编写代码
  • 提交代码
  • 发送 Pull Request

代码编写细则

  • Kotlin文件采用短划线命名法进行命名

    若 Kotlin 文件内只有一个类/接口/对象,则使用帕斯卡命名法进行命名

  • 如非必要尽量不要编写平台函数。

  • 提交 pr 时请确保您的代码可以在所有 target 中运行。有些 API 在commonMain里可以找到,但是在编译到特定平台时就会报错。

  • 资源文件使用SvgToCompose 进行命名,目前可以将图标放在composeApp/src/commonMain/kotlin/top/kagg886/pmf/ui/component/icon中且暴露在root作用域。

  • 在关键的地方加注释,便于理解

Pull Request 细则

  • 标题需要简明扼要地写出这个 pr 主要干的功能,最好不要将多个功能合并在一个 pr 里。
  • 在 pr 的正文中我们应该写出编写这个 pr 的动机以及更详细的改动。
  • 未完成的 pr 可以转为 Draft。
  • 合并一律采用压缩并合并方式。