Skip to content

Commit

Permalink
追加/修正: コントリビュータガイド不足追加と旧式削除 (#1088)
Browse files Browse the repository at this point in the history
* fix: 古い辞書更新方法

* add: ライセンス制約

* add: contrib GitHub Actions 節

* add: contrib, ビルド by Actions

* add: contrib, 一般ガイド
  • Loading branch information
tarepan authored Feb 28, 2024
1 parent 2e961a3 commit c0c5625
Showing 1 changed file with 29 additions and 3 deletions.
32 changes: 29 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ TODO: deprecated 部分を省く
* [ユーザー辞書の更新について](#ユーザー辞書の更新について)
* [Issue](#issue)

## 貢献者の方へ

Issue を解決するプルリクエストを作成される際は、別の方と同じ Issue に取り組むことを避けるため、
Issue 側で取り組み始めたことを伝えるか、最初に Draft プルリクエストを作成してください。

[VOICEVOX 非公式 Discord サーバー](https://discord.gg/WMwWetrzuh)にて、開発の議論や雑談を行っています。気軽にご参加ください。

## インストール

Expand Down Expand Up @@ -109,6 +115,10 @@ LIBCORE_PATH="/path/to/libcore" \
pyinstaller --noconfirm run.spec
```

#### Github Actions でビルド

fork したリポジトリで Actions を ON にし、workflow_dispatch で`build.yml`を起動すればビルドできます。
成果物は Release にアップロードされます。

### コードフォーマット

Expand Down Expand Up @@ -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
不具合の報告、機能要望、改善提案、質問は<a href="https://github.com/VOICEVOX/voicevox_engine/issues/new">Issue</a>の方に報告してください。

0 comments on commit c0c5625

Please sign in to comment.