Skip to content

Latest commit

 

History

History
56 lines (33 loc) · 3.95 KB

File metadata and controls

56 lines (33 loc) · 3.95 KB

「bridge.」 への貢献をご検討いただきありがとうございます。

このリポジトリへ貢献する際は必ずこの文章を必ず最後まで読み切ってから作業を開始してください。

このアプリにはアプリコードの貢献はもちろん、このREADMEファイルの改良やローカライズファイル(src/locales/*.json)の改良も大歓迎です!

この貢献ガイドラインは日本語バージョンです。元ファイルは こちら。 ローカライズチームは常に新しい情報をチェックしていますが、情報が古い場合があるのでご注意ください。

また、訳者のちょっとした注釈も加えております。

開発の開始

コードの編集にはVisual Studio Code(通称VSCode)の使用をお勧めします。インストールはこちら (英語) アプリケーションのテストを開始するには、NodeJS (日本語) のインストールが必要です。(v20.19.5LTS以上を強く推奨します。) NodeJSが既にインストールされているか、インストールした場合は

Linuxの場合はターミナルを開き、「bridge.」 をクローンしたディレクトリに移動して'npm i' ('npm install'でも可) を実行してください。その後、'npm run dev'を実行してターミナルに表示されるlocalhostのリンクをブラウザーのアドレス欄に入力して開発環境を起動し、**「bridge.」**の開発を開始できます。

Windowsの場合はコマンドプロンプトまたはPowershellを開き、**「bridge.」をクローンしたディレクトリに移動して'npm i' ('npm install'でも可) を実行してください。その後、'npm run dev'を実行して実行結果をlocalhostのリンクをブラウザーのアドレス欄に入力して開発環境を起動し、「bridge.」**の開発を開始できます。

どちらのOSでも'npm run build'を使用すると 「bridge」 の製品版をビルドできます。

ネイティブビルド

bridge. v2のネイティブ版ビルドにはTauri (日本語) を使用します。開発モードでネイティブアプリを実行する場合は、こちら (英語) の手順に従ってください。少し古い情報だという警告がありますが役に立つはずです。その後、'cargo install tauri-cli'を実行してTauri CLIをインストールします。 これで、'cargo tauri dev'を実行し、開発モードでネイティブアプリを起動できます。

コードルール

動作確認

このリポジトリに貢献するすべてのコードは動作確認済みである必要があります。つまり、機能は少なくとも一度はテストし、予期しない動作が発生していないことを確認してください。アプリケーションのビルド時にもコンソール内にエラーが出ていないか確認する必要があります。 ('npm run dev'か'cargo tauri dev'を実行して正しく動作するか、'npm run build'でエラーが一つも出ていないか)

コードスタイル

基本事項

このコードベースでは、コミット前にPrettierを使用してコードを自動整形します。最もスムーズな作業環境のため、VS Code用のPrettier拡張機能のインストールを推奨します。

名前付け

すべての識別子名はキャメルケース(camelCase)で記述してください。

// 例
let myVar = 'Hello World!'

function doSomethingNow(par1, par2) {
	doSomething(par1 + par2)
}

プルリクエストの作成

作業は必ず「dev」ブランチで行ってください。プルリクエストは「dev」ブランチをベースとして作成してください。