Wikiへの寄稿の仕方 #

このページはWikiへの寄稿の方法が書いてあります。

用語解説 #

この記事には専門用語がたくさん出てくるので、それらを解説します。

この説明でわからなかった方はGoogleなどで検索してみてください。

GitHubアカウントの作成 #

まず、Wikiの管理に使用する、"GitHub"のアカウントを作成しましょう。

アカウントの作成に関してはWeb上に情報が存在しますので、それを参考に進めてください。

GitHubは英語で分かりにくいかもしれませんが、翻訳サイトなどを使って頑張ってみてください。

アカウント各種設定 #

アカウントが作成できたら、最低限の設定を行います。

github.comにアクセスし、右上のプロフィール画像をクリックしてメニューを開きSettingsをクリックします。

「Email」をクリックし、ページの下の方に Keep my email addresses private というチェックボックスがあるのでそこにチェックを入れてください。

このチェックを入れることによって、コミット&プッシュしたときにメールアドレスが知られてしまうことを防ぐことができます。

※余談ですがこの記事を執筆した人は、このチェックを入れずにコミット&プッシュしてしまいサーバー上層部の方に超個人用のメールアドレスを知られてしまいました。（私みたいにならないように皆さんはチェックを入れておきましょう！）

チェックを入れることができたら、いよいよ執筆です。

執筆作業 #

執筆を行うには、いくつかの方法がありますが、今回はGitHubを使って直接執筆を行う方法を紹介します。

GitHubで執筆する #

まず、GitHubのレポジトリ（フォルダーみたいなもの）をフォーク（自分のアカウントにコピーすること）します。

GitHubでのFREESERVER Wikiのレポジトリに移動し、Forkのボタン（画像赤枠）をクリックします。

Forkできたら、Nakatai-0322/freeserver-wikiのように{アカウント名}/freeserver-wikiになっていると思います。

そのレポジトリを編集して、本番環境のfreeserver-project/freeserver-wikiに変更を持っていくという感じです。

編集する場合 #

編集の方法は内容にもよりますが、今回は例としてdocs/menu.md（「メニューについて」の記事）を編集します。

レポジトリを開き、該当の記事の元ファイル（*.md）を探しましょう。

ペンのマークのボタンをクリックして、編集します。

編集が終了したら、ページの下にCommit Changesというボタンがありますので、クリックしてコミット&プッシュします。

コミット&プッシュできたら自分がフォークしたレポジトリに戻って、Contributeと書かれたボタンがあるのでクリックします。

すると、Open pull requestと書かれたボタンが出てきますので、クリックします。

Comparing changesという画面に移動します。

自分のした変更が確認できますので、確認したらCreate pull requestと書かれたボタンをクリックします。.

Open a pull requestという画面に移動しますので分かりやすいプルリクエスト名にして、必要であれば変更内容を書いたコメントを書きましょう。

プルリクエストが作成できたらサーバー運営からのチェックを受けて正式にWikiの方に反映されます。

※反映するにあたってあなたの案が修正される、もしくは修正をお願いされることがあります。

どこがいけないのかを確認し、それに合わせて自分のフォークしたレポジトリを確認しましょう。