自分のコードを提出する

Estimated reading time: 3 minutes
注意

Github アカウント がない場合は、Telegram グループに参加できます

DANGER

このページは開発者向けではありません。

WARNING

このページは、コンピューターに KotlinAndroid 開発環境があることを前提としています。

一般的な手順

  • ブランチをフォーク
  • コードを書く
  • コードをコミット
  • プルリクエストを送信

コード記述ガイドライン

  • Kotlin ファイルはケバブケース命名を使用しています

    Kotlin ファイルに 1 つのクラス/インターフェース/オブジェクトのみが含まれている場合、PascalCase 命名を使用してください

  • 必要な場合を除き、プラットフォーム固有の関数を書き込まないようにしてください。

  • PR を送信する場合は、コードがすべてのターゲットで実行できることを確認してください。 いくつかの API は commonMain で見つかる可能性がありますが、特定のプラットフォームにコンパイルするときにエラーがスローされることがあります。

  • リソースファイルは SvgToCompose 命名を使用し、現在のアイコンを composeApp/src/commonMain/kotlin/top/magic-cucumber/pmf/ui/component/icon に配置できます。root スコープで公開してください。

  • 理解を支援するために、重要な場所にコメントを追加してください

プルリクエストガイドライン

  • タイトルはこの PR の主な機能を簡潔に説明してください。複数の機能を 1 つの PR にまとめることは避けた方が良いです。
  • PR の本体では、この PR を作成した動機を記述し、より詳細な変更を提供する必要があります。
  • 未完成の PR をドラフトに変換できます。
  • マージは常に Squash and merge メソッドを使用して実行されます。