※この記事は非開発者に向けた大雑把な記事なので正確性に欠けています
Githubとはフリーソフトなどを管理しやすくするためのサイトです
機能が豊富で大体のことは無料で行えるので人気があります
日本語に対応しておらず専門用語もたくさん出てくるので使い方をマスターするのには時間がかかります
なのでこの記事では非開発者にとって便利だと思う機能をいくつかピックアップして解説します
目次
ダウンロードする
Githubでソフトを配布しているとしばしばダウンロード方法がわからないなどの質問が来るので解説します
ダウンロードしたいソフトのページにあるReleasesをクリックしてリリースのページを表示します
ここにNo releases publishedやThere aren’t any releases hereと書いていればそのソフトはGithubで配布されていないので使い方のページを確認したりして配布されている外部リンクを確認してください
Releases
Releaseを開くと色々でてくると思いますがこれは過去のバージョンもダウンロードできるようになっているためです
上の方にある緑色でLatestと書いているやつが最新版です
Pre-releaseと書いてるやつはベータ版なので動作が不安定かもしれません
ダウンロードするバージョンを決めたらAssetsを開きます(普通はLatestで良い)
Source code と書かれているファイルはプログラムそのもののファイルなのでダウンロードすることはないと思います
それしかない場合はそのソフトはGithubで配布されていないので使い方のページを確認したりして配布されている外部リンクを確認してください
Windowsのソフトであれば.exeや.msiや.zipで配布されていると思います
x86とx64とArmで2種類以上配布されている場合は下記のどっちのバージョンかを確かめるをご覧ください
Setup.exeって書かれているのがあればそれをダウンロードすれば良いです
Environments
Web上で動くプログラムの場合はEnvironmentsに載っているサイトを開くとサイトにアクセスできたりします(使い方を掲載したサイトだったりホームページの場合もあります)
それ自体がない場合はそれで配布されていません
Environmentsをクリックすると表示されるページのDeployed to github-pagesにあるView deploymentを押すとサイトにアクセスできると思います
どっちのバージョンかを確かめる
使い方を見る
ソフトのページの下の方にREADME.mdやREADME.txtと書かれた物があると思います
翻訳すると 必ず読んで.md です
大体はここに使い方が書いていると思いますがDocsやDocumentsと書かれたサイトに誘導しているソフトもあると思うのでその場合はそのページを読んで下さい
また、上部のWikiというタブに書いていることもあります Wikiというタブ自体が無かったり開いてもWelcome to the xxxx wiki!と表示される場合はWikiがありません
上記の ダウンロードする の段落でも書きましたがEnvironmentsに使い方のサイトが掲載されている場合もあります
いいねする
昔のTwitterを連想させますがGithubはスターがいいねです
励みになるので積極的に付けていって良いです
ソフトのページの上の方のStarというボタンを押せば押せます
アップデートなどの通知を受け取る
Githubにはソフトウェアにアップデートがあったときに通知を受け取るような設定をすることが出来ます
WatchをクリックしてCustomを選択します
そしてReleasesとSecurity alertsにチェックを付けてApplyを押すと完了です
受け取らないようにするにはParticipating and @mentionsを選択します
Release を作っていないソフトウェアではこの方法で通知を受け取ることは出来ないので注意してください
Releaseの確認方法は上記の ダウンロードする の段落で確認してください
バグ報告や新機能のリクエストを送る
Issuesというタブからバグ報告や新機能の確認をすることが出来ます
小さいことでも気軽に送って下さい
そのタブの中の New Issues というボタンをバグ報告や新機能のリクエストを送る事ができます
ソフトによってはテンプレートが用意されている場合があるのでその場合はそれに従って書きます
Get startedを押すとそのテンプレートが選択されます
注意
適当に書くと無視されたり開発者から嫌われるので丁寧に責任を持って書きましょう
また返信が合った場合はすぐに対応しましょう
既に同じIssueが立ってないか確認してください
検索機能もあるので活用すればすぐ確認できます
書く
言語は基本的に開発者が使用している言語か英語で書きます
なので開発者が日本語を使っている場合は日本語を使って良いです
バグ報告は最低でも400文字は書きましょう(あくまで目安ですが)
タイトルはTitleに書きます
タイトルはできるだけ簡潔に分かりやすく書きます
本文はマークダウン記法という記法で装飾を出来るので見やすく書きます
例えばバグ報告の場合、エラーが表示されるのであればエラーを ` ` で囲んで見やすくします
Previewを押すと装飾された結果が表示されるのでそれで確認できます
新機能のリクエスト
以下の情報は必ず書きます
- 欲しい機能
- その理由
バグ報告
以下の情報は必ず書きます
- ソフトのバージョン
- 使っている環境 (Window10とかAndroid12とかGoogleChrome102とか)
- エラーの全文 (表示されるなら)
- 再現の方法
バグ報告の場合はエラーは全文を書きます
意味のない英語の文字列に見えても開発者はそれを理解できるので非常に大切な情報となります
開発者の環境でもバグが再現できるように説明をします
再現できないバグは報告しないでください
余裕があれば発生しない状態も作れると良いです(～の設定のときはバグが発生しない、逆に～の設定のときのみバグが発生するなど)
バグ報告で送信する情報は細ければ細かいほうが良いです
細かく書けばエラーの全文を除いても400文字は普通に超えます
あとがき
一行目から正確性に欠けてて自分がこんな説明されたら横から口出ししてしまいそうです
個人的には通知の受け取り方が一番書きたかった
自分のプロジェクトのREADMEにこのURLを貼って使うつもり