docs

資料の書き方・作り方

ここでは GitHub Desktop と Visual Studio Code を使った方法について紹介します．事前にインストールしておいてください．

GitHub -> https://dwsktop.github.com/download
VSCode -> https://code.visualstudio.com/download

資料を管理する場所

基本的に https://github.com/I-Sys-UF/docs で管理しています．

手順書

ここからは資料を作成する方法についてです．
まずはリポジトリをクローンしましょう．

左上の File から Clone repository... か [Ctrl] + [Shift] + [O] を押すかしてください．
すると以下のような画面が表示されます

URL タブをクリックして，以下のリンクをペースト

https://github.com/I-Sys-UF/docs.git

Local path は C:\Users\${USERNAME}\Documents\GitHub\docs あたりでいいでしょう．
※ ${USERNAME} の部分にはあなたのパソコンのユーザーネームが入ります．

この状態でクローンすると，以下のようになります．

画面上部の黒い帯の左から 2 番目，Current branch をクリックし，New branch から新しいブランチを作成します．名前はわかりやすいものを考えてください．
今回は例として Markdown 記法を簡単にまとめた資料を書くので，markdown としておきます．
名前を決めたら，Create branch をクリックしましょう．作業後にブランチを残しておく場合は作成の必要はなく，ブランチを切り替えるだけで大丈夫です．

そうしたら，画面中央の Open in Visual Studio Code をクリックしましょう．以下の赤丸の部分です．VSCode が立ち上がります．

必要に応じてディレクトリを作成します．作成する場合は以下の赤丸の部分をクリック．

今回は ./zatsu/ に作成するので > zatsu を開いてファイルを作成します．
ファイル作成は，作成したいディレクトリをクリックした状態で，以下の赤丸の部分をクリック．拡張子は .md にしてください．

以下のように，Markdown 記法を使って文章を書きます．
Markdown 記法については https://I-Sys-UF.github.io/docs/zatsu/markdown.html か GitHub の公式リファレンス

一通り書けたら commit を作成しましょう．commit は変更履歴の最小単位です．

GitHub Desktop に移動し，簡単にコミットメッセージを書きます．

そして左下の青色のボタン，Commit to markdown とありますが，これをクリックしてコミットを打ちます．
もうもう書くことがないなら VSCode は閉じてしまいましょう．

今この様になっていると思いますが，画面中央部に Publish branch のボタンが出てきていますので，これをクリック．

すると Preview Pull Request となりました．これをクリックすると，以下のように自分が行った変更が表示されます．

右下，Create pull request からプルリクエストを発行しましょう．クリックすると，以下のようにブラウザでプルリクエストを発行する画面が表示されます．
ログインを求められた場合はログインしてください．

プルリクエストの内容が分かる簡単なタイトルを付け（初期設定ではコミットメッセージがそのまま出てくる？），Add a description に具体的な説明を書きます．
ここは変更内容に応じて適宜書いて下さい．

その後，以下の赤丸で囲った歯車部分から Reviewer を設定します．とりあえず 53175ddd と打って出てきた人を選択してください．

他に関係者がいる場合は，その下の Asignees から追加してください．

そして右下の緑のボタン，Create pull request をクリックしてください．

これでやることは終わりです．その後は私が変更内容を確認し，marge します．
お疲れ様でした．