Version v0.24 of the documentation is no longer actively maintained. The site that you are currently viewing is an archived snapshot. For up-to-date documentation, see the latest version.

Contribution Guidelines

Komapperへ貢献する方法

概要

Komapperはオープンソースプロジェクトです。 KomapperとKomapperのドキュメンテーションを改善するためのパッチやコントリビューションを歓迎します。

Contributing to Komapper

Komapperのソースコードは https://github.com/komapper/komapper にあります。

Code reviews

プロジェクトメンバーによる修正を含め、すべての修正にはレビューが必要です。 この目的のためにGitHubのプルリクエストを使用します。 プルリクエストの使い方については、GitHub Help を参照してください。

Creating issues

Komapperで期待通りに動かないものを見つけたが解決する方法がわからない場合は、 issue を作成してください。

Contributing to these docs

本ドキュメントは Hugo で作成されたサイトから提供されます。

サイトのデプロイメントを管理するためにGitHubとNetlifyを使用しています。 ここでの説明はGitHubの基本的なワークフローに精通していることを前提としています。

Quick start

  1. GitHubで Komapperのドキュメンテーションレポジトリ をフォークします。
  2. 変更を加えプルリクエストを送ります。

Updating a single page

ドキュメントを参照しているときに変更したい点を見つけた場合、以下のショートカットが使えます。

  1. ページの右上にある ページの編集 をクリックします。
  2. フォークの適切なページが編集モードで表示されます。
  3. 変更を加えプルリクエストを送ります。

Previewing your changes locally

自分のローカルHugoサーバーを実行し、作業しながら変更点をプレビューしたい場合は次の手順に従ってください。

  1. git cloneを使って Komapperのドキュメンテーションレポジトリ のローカルコピーを作ります。 その際、--recurse-submodulesの指定を忘れないようにしてください。さもないと動作するサイトを生成するために必要なコードの一部を取得できません。

    git clone --recurse-submodules --depth 1 https://github.com/komapper/komapper.github.io.git
    
  2. komapper.github.ioディレクトリに移動後、次のdockerコマンドの実行によりサイトをビルドしHugoサーバーを起動させます。

    docker compose up
    

    デフォルトでは、サイトは http://localhost:1313/ で利用できます。 Hugoはコンテンツの変更を監視し自動的にサイトを更新します。

  3. GitHubの通常のワークフローに従って、ファイルを編集し、コミットし、フォークに変更をプッシュし、プルリクエストを作成します。

Creating an issue

もし、ドキュメントを修正したいが解決する方法がわからない場合は、このリポジトリ にissueを作成してください。 特定のページに関するissueを作成するには、そのページの右上にある ドキュメントのissueを作成 リンクをクリックします。

最終更新 October 8, 2021: Remove GitHub Page description (a0e6492)