Wikiの記述環境の作成#

このWikiは、誰でも編集できるWikiです。このWikiの書き方について説明します。

記述環境の作成#

• GitHubのアカウントを作成してください。
• Python 3.10以上をインストールしてください。
• Gitをインストールしてください。

wikiのフォーク#

このリポジトリをフォークしてください。

https://github.com/shimane-u-pim/wiki の画面右上にあるForkボタンからフォークできます。

もし久しぶりに編集する場合#

フォークの更新を行ってください。

https://github.com/<あなたのユーザ名>/wiki の画面にSync Forkボタンがある場合、それを押し、Update branchを押してください。

もしUpdate branchボタンがない場合、更新はありません。

ローカル環境の作成#

フォークしたリポジトリをローカルにクローンしてください。

git clone https://github.com/<あなたのユーザ名>/wiki.git pim-wiki

pim-wikiディレクトリが作成されます。 これから先はこのディレクトリ内で作業します。

ローカル環境の更新#

ローカル環境を更新するためには、pim-wikiディレクトリ内で、 以下のコマンドを実行してください。

git checkout master
git pull

作業環境の構築#

この動作はgit clone後の最初の1回のみ必要です。 pim-wikiディレクトリ内で、 以下のコマンドを実行してください。

python -m venv .venv

作業環境の有効化#

この作業は毎回必要です。

pim-wikiディレクトリ内で、 以下のコマンドを実行してください。

.\.venv\Scripts\activate.bat

画面に.venvと出れば成功です。

もし、画面左にPSから始まる行がある場合、上記コマンドではなく、 以下のコマンドを実行してください。

Set-ExecutePolicy Unrestricted -Scope Process
.\.venv\Scripts\Activate.ps1

画面に緑色の(.venv)が出れば成功です。

作業環境の更新#

git pullを行った後は必ず以下のコマンドを実行してください。 最初の1回目でも必須です。

pip install -r requirements.txt

変更用のブランチの作成#

pim-wikiディレクトリ内で、 以下のコマンドを実行してください。

git checkout -b <あなたのブランチ名>

<あなたのブランチ名>は、あなたの作業内容に応じて適切な名前にしてください。

ファイルの編集#

適切にファイルの編集・追加・削除を行ってください。

書式については別の記事を参考にしてください。

変更点のステージング#

pim-wikiディレクトリ内で、 以下のコマンドを実行してください。

git add -A

変更点のコミット#

pim-wikiディレクトリ内で、 以下のコマンドを実行してください。

git commit -m "変更内容"

"変更内容"は、あなたの変更内容に応じて適切な内容にしてください。

動作確認#

pim-wikiディレクトリ内で、 以下のコマンドを実行してください。

mkdocs build

正常にコマンドが終了し、エラーが出力されなければ正常です。

Aborted with 2 warnings in strict mode!

等が出力された場合、エラーが出ている部分を修正し、 #変更点のステージングからやり直してください。

変更点のプッシュ#

pim-wikiディレクトリ内で、 以下のコマンドを実行してください。

git push origin <あなたのブランチ名> -u

<あなたのブランチ名>は、#変更用のブランチの作成で作成したブランチ名です。

プルリクエストの作成#

GitHubのあなたのFork画面で、プルリクエストを作成してください。

後はこちら側で確認し、マージします。

作業用ブランチの終了#

作業が終了したら、 pim-wikiディレクトリで、 以下のコマンドを実行してください。

git checkout master