重要

翻訳は あなたが参加できる コミュニティの取り組みです。このページは現在 79.78% 翻訳されています。

1. 貢献のための一歩一歩

注釈

ここでは手順の説明のためにQGISドキュメントを使用しますが、以下で説明するコマンドおよび手順はすべて、QGISウェブサイトにも当てはまります。

あなたがこの文章を読まれているということはきっと、QGISドキュメントに貢献しようという気持ちがあって、そのための方法を探されているのでしょう。 ここで提供しようとしているのは、まさしくそれです。現在この文書では、目的を達成するための複数の方法を一通り案内し、従うべき主な手順を示し、使用可能な小技と知っておくべき落とし穴を教えています。

何か助けが必要なときには迷わず、修正しようとしているIssueレポートのコメントに書き込むか、 QGISコミュニティチームメーリングリスト に投稿をしてください。 QGISコミュニティサポート に関する一般情報をお読みください。

さあ、では集中して始めてみましょう。

ドキュメントのソースはgitバージョン管理システムを使って保存され、GitHubのhttps://github.com/qgis/QGIS-Documentation で公開されています。修正すべき問題や説明すべき機能の一覧は、https://github.com/qgis/QGIS-Documentation/issues にあります。

Tip

初めて貢献される方で、何から始めたらいいかわからないという方は、`問題レポートへようこそ<https://github.com/qgis/QGIS-Documentation/contribute>`_ に取り組むのが面白いかもしれません。

ファイルを修正するには、排他的ではない2つの方法があります:

  1. GitHub のウェブインタフェースを使用する

  2. Git コマンドラインツールを使用する.

1.1. GitHub のウェブインタフェースを使用する

GitHubのウェブインタフェースでは次のことを行うことができます。

  • ファイルを編集する

  • 変更をプレビューし、コミットする

  • 変更がメインリポジトリに挿入されるようにプルリクエストを行う

  • ブランチを作成、更新または削除する

もしあなたがgitやGitHubの語彙にまだ慣れていないなら、GitHubの Hello-world プロジェクトを読んで、以下で使用する基本的な語彙やアクションを学ぶとよいでしょう。

注釈

報告されたissueを修正するとき

もしあなたが issue を修正するための変更を加えている最中なら、issueレポートにコメントをして、それをあなた自身に割り当ててください。これにより、複数の人が同じissueに取り組むことを防ぐことができます。

1.1.1. QGISドキュメントをフォークする

GitHubアカウント をすでに取得していれば、まず最初にするべきは、ドキュメントのソースファイルをフォークすることです。

QGIS-Documentation のリポジトリ ページに移動して、右上隅の githubFork ボタンをクリックします。

ご自身のGitHubアカウントに、QGIS-Documentationリポジトリ (https://github.com/<YourName>/QGIS-Documentation) が作られていることと思います。このリポジトリは公式のQGIS-Documentationリポジトリのコピーです。あなたに完全な書込権限が与えられていて、公式のドキュメントに影響を与えることなく変更を加えることができます。

1.1.2. 変更を加える

QGISドキュメントに貢献するにはいくつかの異なった方法があります。以下ではそれらを別々に示しますが、あるプロセスから別のプロセスに切り替えることに何ら問題はありません。

選択肢 1： Edit on GitHub ショートカットを使用する

Pages on the QGIS documentation website can be edited quickly and easily by clicking on the Edit on GitHub link at the top right of each page, or in the drop-down menu at the bottom of the left sidebar.

  1. Edit on GitHub をクリックすると、qgis:master ブランチのファイルが開きます。ページの上部には、あなたにはこのリポジトリへの書込権限がないため、変更はあなたのリポジトリの新しいブランチで適用される旨を知らせるメッセージが、表示されます。

  2. 変更を行います。ドキュメントはreStructureTextシンタックスを使用して書かれていますので、変更の内容によっては、 執筆のためのガイドライン を参照しながら行う必要があるかもしれません。

  3. Once you have finished modifying the file, press Commit changes... and add a short title explaining your changes. You can also provide a more detailed explanation, if necessary.

  4. Press Propose changes, saving the modifications to your repository. This will generate a dedicated branch (patch-xxx) in your repository and the web browser will open the Comparing changes page.

    • If the issue you are addressing does not need any further changes, jump to the Share your changes via Pull Request section below.

    • QGISに送信する前に追加の変更が必要な場合は、次の手順に従ってください。

      1. フォークしたあなたのQGIS-Documentation (https://github.com/<YourName>/QGIS-Documentation) リポジトリに移動します。

      2. Click on githubBranch and search for the new patch-xxx branch.

      3. Select it. The githubBranch button will now display Branch: patch-xxx.

      4. Jump down to the Modify files section below.

選択肢 2：あなたのドキュメンテーションレポジトリに一時的な専用ブランチを作成する

あなたがフォークしたQGIS-Documentationで直接ファイルを編集できます。

First, make sure that your master branch is up to date with upstream, i.e. qgis/QGIS-Documentation:master branch. To do so:

  1. リポジトリのメインページ、つまり https://github.com/<YourName>/QGIS-Documentation にアクセスしてください。master ブランチがアクティブで、qgis/QGIS-Documentation:master が最新かどうかが表示されているはずです。

    そのブランチが上流ブランチより先にコミットしている場合は、master ブランチを揃えるまで、以前の shortcut button alternative を使った方がよいでしょう。

    後ろにコミットがあるだけなら:

    1. Expand the Sync fork drop-down menu on the right. You can:

      • Compare the branches and see new changes in the upstream branch you do not yet have in yours

      • Fetch and merge: brings changes from the upstream branch into yours.

    2. Click Fetch and merge: after the process, your branch is mentioned as up to date with qgis/QGIS-Documentation:master.

  2. Click on githubBranch in the upper left corner of your forked QGIS-Documentation repository and enter a unique name in the text field to create a new branch. It is advised that the name of the new branch relates to the problem you intend to fix. Convenient for identifying the branch later.

  3. Press Create branch <branch_name> from master. The githubBranch button should now display branch_name.

  4. You are ready to start new changes on top of your new branch.

注意

変更はこの一時的な専用ブランチで行うこと。絶対に master ブランチでは行わないこと

qgis/QGIS-Documentation の master ブランチからあなたのQGIS-Documentationリポジトリに変更をマージする場合を除いて、 慣例として master ブランチでは変更を行わないでください。問題ごとに別々のブランチを使用することによって、他のブランチに干渉することなく、同時に複数の問題に取り組むことができます。間違えた場合は、いつでもブランチを削除して、masterブランチから新しいブランチを作成してやり直すことができます。

1.1.3. ファイルを変更する

  1. Make sure the branch you want to modify is active: its name is displayed in the top left menu or in the page URL.

  2. Browse the source files to the file that needs modifications.

  3. Press the githubEditPencil Edit this file button.

  4. Update the text following the writing guidelines

  5. Once you have finished modifying the file, press Commit changes... and add a short title explaining your changes. You can also provide a more detailed explanation, if necessary.

  6. Make sure Commit directly to the <branch_name> branch is selected.

  7. Press Commit changes to save your modifications in the branch.

  8. To update or add a new image file:

    1. Browse your branch to the folder of the file to update or add.

    2. Top right, use the Add files ► Upload files menu to select and load files from your drive. You can find hints for formatting an image for the docs at スクリーンショットを管理する.

    3. If a file of the same name already exists, it gets overwritten.

    4. Commit once again your changes to the target branch.

  9. Repeat the previous steps for any other files that need to be updated to fix the issue.

1.1.4. プルリクエスト経由で変更を共有する

You need to make a pull request to integrate your changes into the official documentation.

新しいプルリクエストを始める

  1. If you used the Edit on GitHub link, after you commit your changes, GitHub automatically opens a new page comparing the changes you made in your patch-xxx branch to the qgis/QGIS-Documentation:master branch.

  2. In all the cases, the comparing changes page can be reached by going to the "Pull requests" page of your repository and click on New pull request.

変更を比較する

一方が base:master 、もう一方が ``compare:branch_name` （図を参照）という2つのダイアログボックスが表示されている場合は、あなたの行った変更はあなたのリポジトリの中で、変更を加えたブランチからあなたのマスターブランチへとマージされるだけです。これを修正するために compare across forks と表示されているリンクをクリックします。

../../_images/githubCompareAcrossForks.png

図 1.8 Comparing changes ページがこのようなものだったら、 compare across forks リンクをクリックします。

4つのドロップダウンメニューが表示されていることと思います。このドロップダウンメニューによって、あなたのブランチで行った変更を、変更をマージしたい相手である公式のマスターブランチと比較することが可能になります。4つのドロップダウンメニューは以下の通りです。

  • base fork ：あなたの変更をマージしたい相手先のフォーク

  • base ：あなたの変更をマージしたいbase forkのブランチ

  • head fork ：base forkに組み込みたい変更があるフォーク

  • compare ： 変更が行われたブランチ

base fork で qgis/QGIS-Documentation を、base で master を選択します。head fork をあなたのリポジトリ <YourName>/QGIS-Documentation に、compare をあなたが変更を行ったブランチに設定します。

../../_images/githubCreatePullRequestComparison.png

図 1.9 qgis/QGIS-Documentation とあなたのリポジトリとの間で変更を比較している

Able to merge と書いてある緑色のチェックマークは、あなたの変更が衝突することなく公式のドキュメントにマージできることを示しています。

Create pull request ボタンをクリックします。

警告

githubCantMerge と表示されたら

これは 競合 があることを意味します。他の誰かがあなたの変更と衝突するコミットを行ったため、あなたが変更しようとしているファイルはあなたがターゲットとしているブランチの最新版ではありません。プルリクエストを作成することはできますが、マージを完了させるためには conflicts を修正する必要があります。

Tip

最新バージョン のQGISドキュメントは、翻訳されてはいますが、保守は継続しており、問題が見つかれば修正が行われています。特定リリースの問題を修正する場合は、上記の手順で base を master から適切な release_... ブランチに変更してください。

プルリクエストを記述する

A text box will open: fill in a title and any relevant description of the changes you are proposing.

これが特定の issue に関連する場合は、コメントにissue番号を追加します。これは＃とissue番号 (例 #1234) を入力することによって行われます。 直前に fix や close のような語が置かれている場合は、プルリクエストがマージされると、すぐにそのissueはクローズされます。

あなたが変更を行ったすべてのドキュメントのページへのリンクを含めてください。

Create pull request をクリックします。

プルリクエストのレビューとコメント

上で見たように、誰でもプルリクエストを通してドキュメントに修正を加えることができます。同様に、誰でも質問や `コメント<https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request>`_ でプルリクエストをレビューすることができます。書き方がプロジェクトのガイドラインに合っていないかもしれませんし、変更の詳細やスクリーンショットが欠けているかもしれません。レビューすることで、形式と内容の両方で貢献の質を向上させることができます。

プルリクエストをレビューするには

  1. pull requests のページ へ移動して、コメントをしたいプルリクエストをクリックします。

  2. ページの一番下に、このプルリクエストについて全体的なコメントを残すことのできるテキストボックスがあると思います。

  3. 特定の行についてコメントをするには、

    1. Click on githubFilesChanged and find the file you want to comment on. You may have to click on < > Display the source diff to see the changes.

    2. コメントしたい行までスクロールして、 githubBluePlus をクリックします。テキストボックスが開きますので、コメントを残すことができます。

特定の行に対するコメントは、次のいずれかの方法で公開することができます。

  • Add single comment ボタンを使って、単独のコメントとして公開する。この場合コメントはその都度即座に公開されます。コメント数が少ない場合や他のコメントにコメントする場合にのみ、この方法を使ってください。

  • または Start a review ボタンを押します。コメントは検証後に自動的に送信されないので、後から編集したり取り消したり、レビューの要点の要約やプルリクエストに関するグローバルな指示、承認するかどうかを追加することができます。これはより柔軟で、レビューを構成し、コメントを編集し、準備ができたら公開し、リポジトリフォロワーに単独の通知を送ることができ、コメント毎に通知を送らないので、便利な方法です。詳細 を入手してください。

../../_images/githubAddLineComment.png

図 1.10 特定の行に対して修正の提案とともにコメントを行う

行に対するコメントには提案を埋め込むことができ、プルリクエストの作成者はこれをプルリクエストに適用することができます。提案を追加するには、コメントテキストブロックの上にある githubSuggestions Insert a suggestion ボタンをクリックして、提案ブロックの中のテキストを修正します。

Tip

プルリクエストへの提案をバッチとして追加したいときは

プルリクエストの作成者としてレビュワーからのフィードバックを直接プルリクエストに組み込むときに、対処すべき提案の数が多いためにそれらをバッチコミットとして追加したい場合は、コメントの一番下にある Commit suggestion ボタンを使用するのは避けてください。 すなわち、以下のようにします。

  1. githubFilesChanged タブに移動します。

  2. 取り込みたい提案のそれぞれで Add suggestion to batch を押します。押すごとにカウンターが増えるのが分かると思います。

  3. 取り込みたいすべての提案をプルリクエストに適用する準備ができたら、どれでもいいので Commit suggestions ボタンを押して、この変更を説明するメッセージを入力します。

これによってすべての修正がひとつのコミットとしてブランチに追加されます。結果として、変更履歴が読みやすいものとなり、リポジトリのフォロワーに送信される通知の数も減ります。ついでに言えば、この処置によってあなたのクリック数も大きく減らすことができます。

訂正する

新しいプルリクエストは自動的に プルリクエストリスト に追加されます。他の編集者や管理者があなたのプルリクエストを見直し、提案をしたり修正を求めたりするかもしれません。

プルリクエストは自動ビルドチェック（rstフォーマットやpythonコードの構文など）もトリガーし、ページ下部にレポートが表示されます。エラーが見つかった場合、コミットの横に赤い十字が表示されます。赤い十字をクリックするか、プルリクエストページの一番下にあるサマリーセクションの Details をクリックすると、エラーの詳細を見ることができます。報告されたエラーや警告は、変更を qgis/QGIS-Documentation リポジトリにコミットする前に修正する必要があります。

You can make modifications to your pull request until it is merged with the main repository, either to improve your request, to address requested modifications, or to fix a build error:

  1. Click on the githubFilesChanged tab in your pull request page

  2. Press ... menu on the right of the filename that you want to modify, and select Edit file.

  3. The file opens in edit mode; add your modifications and commit.

プルリクエストで使用したのと同じブランチで変更を加えた場合、追加された変更はすべてプルリクエストに自動的に追加されます。このため、追加の変更は、プルリクエストで修正しようとしている問題にその変更が関連する場合にのみ、行うようにしてください。

別の問題を解決したい場合は、それらの変更に対して新しいブランチを作成して上記のステップを繰り返します。

ビルドエラーが修正され、あなたと管理者が変更に満足したら、管理者はあなたの貢献をマージします。

1.1.5. マージしたブランチを削除する

変更がマージされた後でブランチを削除できます。古いブランチを削除すると、未使用のブランチや古いブランチをリポジトリに保存しておく必要がなくなります。

  1. フォークしたあなたのQGIS-Documentationリポジトリ (https://github.com/<YourName>/QGIS-Documentation) に移動します。

  2. Branches タブをクリックします。 Your branches の下にあなたのブランチがあることと思います。

  3. 不要なブランチの deleteSelected Delete this branch アイコンをクリックして削除します。

1.2. Gitコマンドラインツールを使用する

GitHubのウェブインターフェイスは、簡単なやり方でQGIS-documentationレポジトリの更新に貢献することができますが、下記のためのツールは提供していません。

  • 複数のコミットをまとめることによって変更履歴をきれいにする

  • メインリポジトリとの間で生じうる衝突を解決する

  • あなたの変更をテストするためにドキュメントをビルドする

より高度で強力なツールへアクセスし、リポジトリのコピーをローカル環境に持つためには、ハードドライブ上に gitをインストール する必要があります。しばしば必要となる基本的な事項は以下で説明されています。そこではウェブインターフェイスを使用する場合であっても気をつけるべきルールを学ぶことができるでしょう。

以下のコードサンプルでは、 $ で始まる​​行はあなたが入力すべきコマンドを示します。一方、 # で始まる​​行はコメントです。

1.2.1. ローカルリポジトリ

さあ、QGIS-Documentationリポジトリの**あなた用の**コピーをローカル環境に取得する準備はできましたね。

ウェブURLを使った以下のコマンドで、QGISドキュメンテーションリポジトリを複製し取得することができます。

# move to the folder in which you intend to store the local repository
$ cd ~/Documents/Development/QGIS/
$ git clone https://github.com/<YourName>/QGIS-Documentation.git

前者のコマンドラインは単なる例です。パスもリポジトリのURLも適応させ、<YourName> を自分のgithubユーザー名に置き換える必要があります。

次に以下の確認を行ってください。

# Enter the local repository
$ cd ./QGIS-Documentation
$ git remote -v
origin  https://github.com/<YourName>/QGIS-Documentation.git (fetch)
origin  https://github.com/<YourName>/QGIS-Documentation.git (push)
$ git branch
* master

  • origin は、あなたのQGIS-Documentationリポジトリの、リモートリポジトリにつけられた名前です。

  • master はデフォルトのメインブランチです。貢献する際にはこのブランチを使用してはいけません。 絶対に です！

SSHプロトコルを使用してQGISドキュメンテーションリポジトリを複製することもできます。

# move to the folder in which you intend to store the local repository
$ cd ~/Documents/Development/QGIS/
$ git clone [email protected]:<YourName>/QGIS-Documentation.git

Tip

Permission denied (publickey) エラーが出た時は？

前者のコマンドで Permission denied (publickey) エラーが出る場合は、SSH 鍵に問題がある可能性があります。詳しくは GitHub help を参照してください。

SSHプロトコルを使用した場合は確認は以下のようになります。

# Enter the local repository
$ cd ./QGIS-Documentation
$ git remote -v
origin  [email protected]:<YourName>/QGIS-Documentation.git (fetch)
origin  [email protected]:<YourName>/QGIS-Documentation.git (push)
$ git branch
* master

これで始めることができますが、長い間のうちには、あなたの貢献をプッシュした際（GitHubのプロセスではプルリクエストと呼びます）に、たくさんの問題が生じると思います。これは公式のqgis/QGIS-Documentationリポジトリのmasterブランチが、あなたのローカル／リモートリポジトリからだんだんと差異を増してずれていくことによるものです。このため、常にメインリモートリポジトリの状態を追跡したうえで、ブランチにおける作業を行う必要があります。

1.2.2. もうひとつのリモートリポジトリを追加

メインプロジェクトで行われた作業を追跡できるようにするために、ローカルリポジトリに新しいリモートリポジトリを追加します。この新しいリモートリポジトリは、QGISプロジェクト公式のQGIS-Documentationリポジトリです。

$ git remote add upstream https://github.com/qgis/QGIS-Documentation.git
$ git remote -v
origin  https://github.com/<YourName>/QGIS-Documentation.git (fetch)
origin  https://github.com/<YourName>/QGIS-Documentation.git (push)
upstream        https://github.com/qgis/QGIS-Documentation.git (fetch)
upstream        https://github.com/qgis/QGIS-Documentation.git (push)

ローカルリポジトリにリモートリポジトリを追加するときにも、同様にSSHプロトコルを使うことができます。

$ git remote add upstream [email protected]:qgis/QGIS-Documentation.git
$ git remote -v
origin  [email protected]:<YourName>/QGIS-Documentation.git (fetch)
origin  [email protected]:<YourName>/QGIS-Documentation.git (push)
upstream        [email protected]:qgis/QGIS-Documentation.git (fetch)
upstream        [email protected]:qgis/QGIS-Documentation.git (push)

これで2つのリモートリポジトリの、どちらかを選ぶことができるようになりました。

  • origin は あなたの リモートリポジトリに、あなたのローカルブランチをプッシュするときに使用します。

  • upstream は、あなたの貢献を公式のリポジトリにマージしたり（その権限がある場合）、あなたのローカルリポジトリのマスターブランチを公式リポジトリのマスターブランチに従って更新したりする際に使用します。

注釈

upstream は標準の名前のようになっていますが、実際はただのラベルですので、あなたの好きなように名前をつけることができます。

1.2.3. ベースブランチを更新する

新しい貢献に取り組む前には、必ず、ローカルリポジトリのマスターリポジトリをアップデートしなければなりません。

# switch to master branch (it is easy to forget this step!)
$ git checkout master
# get "information" from the master branch in the upstream repository
# (aka qgis/QGIS-Documentation's repository)
$ git fetch upstream master
# merge update from upstream/master to the current local branch
# (which should be master, see step 1)
$ git merge upstream/master
# update **your** remote repository (aka <YourName>/QGIS-Documentation)
$ git push origin master

これであなたのローカルリポジトリとリモートリポジトリ双方の master ブランチを、公式QGIS-Documentationリポジトリの master ブランチに一致するようアップデートしましたので、貢献の作業を始めることができます。

注釈

リリースドキュメントに貢献したい場合はブランチを移動すること

testing版ドキュメントとともに、 latest release 版ドキュメントについても問題を修正する作業が続けられていますので、このドキュメントに対して貢献することも可能です。コード中の master を最新の対応するブランチに置き換えた上で、前セクションのサンプルコードに従ってください。

1.2.4. 制作ブランチに取り組む

ベースブランチを最新に更新しましたので、次は自分の貢献を追加する専用のブランチを作成する必要があります。作業は必ずベースブランチ以外のブランチで行ってください！これは常にです！

# Create a new branch
$ git checkout -b myNewBranch
# checkout means go to the branch
# and -b flag creates a new branch if needed, based on current branch
# Let's check the list of existing branches (* indicates the current branch)
$ git branch
master
release_2.18
...
* myNewBranch
# You can now add your contribution, by editing the concerned file(s)
# with any application (in this case, vim is used)
$ vim myFile
# once done
$ git add myFile
$ git commit

commit/pushコマンドについて一言：

  • ひとつの貢献（それ以上分割することが不可能な変更）だけをコミットするようにしてください。すなわち一度にひとつの問題だけに取り組んでください。

  • コミットのタイトルおよび説明文の中で、変更の内容を丁寧に説明するようにしてください。最初の行はタイトルです。大文字で始め、80文字以内に収め、最後には . を付けないでください。簡潔にしてください。コミットの説明文は長くなってもよいので、より多く詳細について語ることができます。最後は . で終了してください。

  • Issueを参照するには、 # を頭につけたIssue番号を使用してください。チケットを修正する場合は Fix をその前につけておくと、コミットによってチケットが閉じられます。

さあ変更が保存されローカルブランチにコミットされました。プルリクエストを作成するためには、リモートリポジトリに送信する必要があります。

$ git push origin myNewBranch

1.2.5. 変更を共有する

これであなたのgithubのリポジトリに行って、前のセクションで触れたように プルリクエストを作成 することができます。作成したプルリクエストが、自分のブランチから公式のQGIS-Documentationリポジトリ中のターゲットとしているリモートブランチへものであることを確認してください。

1.2.6. ローカルおよびリモートリポジトリをクリーンアップ

プルリクエストが公式のQGIS-Documentationにマージされたら、あなたの制作ブランチは削除してかまいません。この方法で多くの作業をこなした場合、数週間のうちに用済みのブランチがたくさんできると思います。ですので以下のようにしてあなたのリポジトリをきれいに保ちましょう。

# delete local branch
$ git branch -d myNewBranch
# Remove your remote myNewBranch by pushing nothing to it
$ git push origin :myNewBranch

またローカルリポジトリ中の master ブランチを更新して最新の状態を保つことも忘れないでください！

1.3. 参考文献

  • 上記のGithubウェブインターフェイスとgitコマンドラインツール以外にも、ドキュメントへの貢献を作成および管理するために使用できる GUIアプリケーション があります。

  • プルリクエストの変更が、ターゲットブランチにプッシュされた最近の変更と競合している場合は、マージが可能になるよう、先にこの競合を解決する必要があります。

    • 競合が数行の競合に関連する場合、GitHubのプルリクエストページに Resolve conflicts ボタンが利用できます。ボタンを押し、Resolving a merge conflict on GitHub の説明に従って問題を解決してください。

    • ファイルのリネームや削除がコンフリクトに関係している場合は、git コマンドラインを使ってコンフリクトを解決する必要があります。一般的には、まず git rebase targetBranch を使ってターゲットブランチの上に自分のブランチをリベースし、報告された競合を修正しなければなりません。詳しくは コマンドラインを使ったマージの競合の解決 をご覧ください。

  • 校正作業の最後に、複数のコミットに分割された、必ずしも価値のない変更になってしまうことがあります。Git のコマンドラインは、このようなコミットをより少ない数にまとめ、より意味のあるコミットメッセージにするのに役立ちます。詳しくは コマンドラインで git rebase を使う を参照ください