貢献ガイド

English | Français | 한국어 | 日本語

何が貢献できますか？

翻訳、改善、提案、バグ報告など、貢献の方法はさまざまです。

新しい翻訳は、外国語に慣れていない人が新しいことを学ぶのに役立ちます。
新しい機能を追加したり、既存の機能を改善するためのアイデアを提供することは、次のバージョンの開発に役立ちます。
ドキュメントの改善や例の追加は、他の人がより良いユーザー体験をするのに役立ちます。
バグを報告することで、MMGをより安定したものにすることができます。

どのように貢献できますか？

何か提案したり、改善したいことがあれば、GitHubのIssuesに新しい問題を作成してください。
Pull Requestを送ることもできます。
GitHubのDiscussionsで質問してください。

すべての提案は受け入れられますか？

いつも皆さんの意見を歓迎しています。 できるだけ多くの提案を受け入れようとしていますが、現実的にはすべての提案を受け入れることはできません。

次の場合は受け入れられない場合があります。

MMGの方向性と一致しない場合
- MMGはできるだけ直感的に使用できることを望んでいます。
- MMGは、ベースファイルの構造が複雑になることを好みません。
MMGに機能を追加するのではなく、別のプログラムを作成する方が適切な場合
- たとえば、ベースファイルで管理する言語が多すぎる場合、ユーザーがMMGを直接使用するのは非常に不便になる場合があります。そのような場合は、MMGをベースにした新しいGUIプログラムを作成する方が適切です。
オープンソースライセンスに問題がある場合
- MMGはMITライセンスを使用しているため、GPLライセンスと互換性がありません。

次の場合は遅れる場合があります。

有料サービスが必要な機能
- MMGはフリーソフトウェアを目指しているため、有料サービスはオプションとして提供する必要があります。
インターネット接続が必要な機能
- MMGはオフライン環境でも動作する必要があるため、オンラインでのみ動作する機能はオプションとして提供する必要があります。

開発のためにローカルでMMGをビルドするにはどうすればよいですか？

既存のローカル開発環境と競合しないように、Pythonの仮想環境を使用することをお勧めします。 MMGは、開発環境を管理するためにPoetryを使用しています。 Poetryは強力な依存関係管理機能を提供し、仮想環境を管理するのに非常に便利です。

環境の設定

まず、次のように開発環境を設定します。

公式ドキュメントの手順に従ってPoetryをインストールします。
リポジトリをクローンして、プロジェクトディレクトリに移動します。
```
git clone https://github.com/ryul1206/multilingual-markdown.git
cd multilingual-markdown
```
このステップはオプションですが、プロジェクトディレクトリに仮想環境を作成することをお勧めします。これを行うには、次のコマンドを実行します。
```
poetry config virtualenvs.in-project true
poetry config virtualenvs.path "./.venv"
```
仮想環境を作成し、pyproject.tomlファイルで指定された依存関係をインストールします。
```
poetry install --with dev,test,docs
```
仮想環境を有効にするには、次のコマンドを実行します。
```
poetry shell
```

開発

開発環境が設定されたので、MMGを変更してテストできます。変更したMMGを適用するには、次のコマンドを実行します。

poetry install

たとえば、pyproject.tomlでversionを9.9.9-betaに変更した場合、mmg --versionの結果は次のように異なります。

$ poetry shell

------------------------------------------------------------------------
(mmg-py3.11) $ mmg --version
Version 2.0.0

------------------------------------------------------------------------
# Change version in pyproject.toml from 2.0.0 to 9.9.9-beta

------------------------------------------------------------------------
(mmg-py3.11) $ poetry install
Installing dependencies from lock file

No dependencies to install or update

Installing the current project: mmg (9.9.9-beta)

------------------------------------------------------------------------
(mmg-py3.11) $ mmg --version
Version 9.9.9b0