From c0c56252ba013377d60d371526424fe20e19c2f0 Mon Sep 17 00:00:00 2001 From: tarepan Date: Thu, 29 Feb 2024 01:43:06 +0900 Subject: [PATCH] =?UTF-8?q?=E8=BF=BD=E5=8A=A0/=E4=BF=AE=E6=AD=A3:=20?= =?UTF-8?q?=E3=82=B3=E3=83=B3=E3=83=88=E3=83=AA=E3=83=93=E3=83=A5=E3=83=BC?= =?UTF-8?q?=E3=82=BF=E3=82=AC=E3=82=A4=E3=83=89=E4=B8=8D=E8=B6=B3=E8=BF=BD?= =?UTF-8?q?=E5=8A=A0=E3=81=A8=E6=97=A7=E5=BC=8F=E5=89=8A=E9=99=A4=20(#1088?= =?UTF-8?q?)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix: 古い辞書更新方法 * add: ライセンス制約 * add: contrib GitHub Actions 節 * add: contrib, ビルド by Actions * add: contrib, 一般ガイド --- CONTRIBUTING.md | 32 +++++++++++++++++++++++++++++--- 1 file changed, 29 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49399af20..cfcb60373 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,6 +17,12 @@ TODO: deprecated 部分を省く * [ユーザー辞書の更新について](#ユーザー辞書の更新について) * [Issue](#issue) +## 貢献者の方へ + +Issue を解決するプルリクエストを作成される際は、別の方と同じ Issue に取り組むことを避けるため、 +Issue 側で取り組み始めたことを伝えるか、最初に Draft プルリクエストを作成してください。 + +[VOICEVOX 非公式 Discord サーバー](https://discord.gg/WMwWetrzuh)にて、開発の議論や雑談を行っています。気軽にご参加ください。 ## インストール @@ -109,6 +115,10 @@ LIBCORE_PATH="/path/to/libcore" \ pyinstaller --noconfirm run.spec ``` +#### Github Actions でビルド + +fork したリポジトリで Actions を ON にし、workflow_dispatch で`build.yml`を起動すればビルドできます。 +成果物は Release にアップロードされます。 ### コードフォーマット @@ -169,12 +179,28 @@ poetry export --without-hashes --with test -o requirements-test.txt poetry export --without-hashes --with license -o requirements-license.txt ``` -### ユーザー辞書の更新について +#### ライセンス + +依存ライブラリは「コアビルド時にリンクして一体化しても、コア部のコード非公開 OK」なライセンスを持つ必要があります。 +主要ライセンスの可否は以下の通りです。 + +- MIT/Apache/BSD-3: OK +- LGPL: OK （コアと動的分離されているため） +- GPL: NG （全関連コードの公開が必要なため） + +### GitHub Actions + +#### Variables -以下のコマンドで openjtalk のユーザー辞書をコンパイルできます。 +| name | description | +| :----------------- | :------------------ | +| DOCKERHUB_USERNAME | Docker Hub ユーザ名 | -poetry run python -c "import pyopenjtalk; pyopenjtalk.create_user_dict('default.csv','user.dic')" +#### Secrets +| name | description | +| :-------------- | :---------------------------------------------------------------------- | +| DOCKERHUB_TOKEN | [Docker Hub アクセストークン](https://hub.docker.com/settings/security) | ## Issue 不具合の報告、機能要望、改善提案、質問はIssueの方に報告してください。