コントリビュートガイド
この記事では、Lantanaに貢献する方法について説明します。
Lantanaプロジェクトは、世界中の開発者やユーザーからの貢献を歓迎しています。 貢献には、次のようにさまざまな種類があります。
- 新機能の提案
- ドキュメントの改善
- 不具合の報告や修正
- ドキュメントやテキストの翻訳
どのような貢献をどの程度していただいても構いません。 もし、貢献をする前に質問がある場合は、Discussionsでトピックを立てて質問できます。
不具合の報告について¶
Lantanaを使っていてお気づきになられた不具合は、Issueに報告してください。
報告するときは、Issueテンプレートに従って、遭遇した不具合をできるだけ詳細に記入してください。報告時には、以下の情報を収集してください。
- LantanaのバージョンとMkDocsのバージョン、使用しているブラウザとそのバージョンをお知らせください。
- 不具合が目に見えてわかる場合(デザインの問題や崩れなど)、スクリーンショットも添付してください。
- エラーが発生した場合は、エラーメッセージとスタックトレースを添付してください。
Canary版を試してみる¶
次のコマンドを実行することで、Lantanaの開発中の最新版を試してみることができます。この作業によって、新機能を体験したり、不具合を再現できます。
注意
Canary版には、未修正の不具合が含まれている可能性があります。
Canary版のインストールは、venv
内で行うことを推奨します。
開発作業を行う¶
開発の前の準備や全体の流れは、コードやドキュメントの編集で説明しています。
開発中のLantanaをインストールする¶
開発中のLantanaをコンピューターにインストールするには、ディレクトリで次のコマンドを実行します。
編集モード
コードを編集可能な状態でインストールするには、-e
オプションをつけてコマンドを実行します。