コードやドキュメントの編集

この記事では、コードやドキュメントの編集方法について説明します。


taiseiue | 2024-11-21

Lantanaへのコントリビュートに興味をお持ちいただき、ありがとうございます。 ドキュメントやソースコード、翻訳を修正するには、リポジトリをフォークして、そのリポジトリを編集し、Pull Requestを提出します。

1.リポジトリのFork

  1. Lantanaのリポジトリを開いて、「Fork」をクリックします。
  2. フォームの内容を確認して「Create Fork」をクリックします。

2.リポジトリのClone

コードやドキュメントを修正するには、リポジトリをcloneする必要があります。 この作業によって、ローカルマシンとGitHubの間でLantanaのコードが同期されます。

以下のコマンドを実行してcloneできます。<account-name>には、あなたのアカウント名(つまり、フォーク先のアカウント名)を当てはめてください。

git clone https://github.com/<account-name>/lantana.git

3.コードまたはドキュメントを修正する

ソースコードまたはドキュメントを修正します。 ドキュメントはdocsディレクトリに、テーマはlantanaディレクトリにあります。

ドキュメントの編集中やテーマの修正中に、現在開発中のLantanaをリアルタイムで確認するには、ディレクトリで次のコマンドを実行します。

script/serve

正常にコマンドが実行されていれば、http://127.0.0.1:8000/で開発中のLantanaが動いています。Ctrl+Cを押すことで、コマンドを終了できます。

ただし、Pythonコードを修正したときや、翻訳を修正したときは、一度コマンドを終了してもう一度実行する必要があります。

4.コミットする

修正がひと段落したら、コミットして作業を保存します。 ある程度の作業のまとまりごとにコミットすることをお勧めします。

次のコマンドでコミットできます。

git commit コミットメッセージ

5.Pull Requestを提出する

修正が完了したら、WSOFT-Project/lantanaのリポジトリに作業内容を反映するためにPull Requestを提出する必要があります。

あなたがフォークしているリポジトリで、「Pull Requests」タブからPull Requestを作成してください。その際、baseWSOFT-Project/lantanaになっていることを確認してください。

Pull Requestの提出以降、数日以内に担当者がレビューします。 追加の対応を求めるコメントを送信する可能性もあります。GitHubの通知を受け取れるようにしておいてください。