Webチームで案件の開発をする際は、ソースコードは先方に帰属させる必要があるため、先方用にOrganizationを作り、その中にリポジトリを作る。開発する際はそのリポジトリをwinc1980にForkし、Forkしたリポジトリ上で開発する。このドキュメントでは、案件の開発用リポジトリを、新規作成したOrganization内に作る手順を説明する。GitHubで新規Organizationを作る手順はこのマニュアルを参照すること。

手順

  1. 案件用にテンプレートリポジトリを用意しているので、そこにアクセスする。

    リポジトリのリンク

    capture1.png

    ※2024/10/16現在、テンプレートリポジトリはastro-develop-templateしかないが、今後別のフレームワークで構成したテンプレートを作ってそれを使用するのは自由である。あくまで、2024年度の案件はこのテンプレートを使用するだけであり、Webの技術の発達はめまぐるしいので、その時々に最適な構成を考えて作るようにしてほしい。

  2. Download ZIPをクリックしてZIPファイルをダウンロードする。

  3. ダウンロードしたZIPファイルを解凍し、フォルダ名を任意の名前に変更する。この名前がリポジトリ名になる。GitHub Pagesでサイトを公開する場合、リポジトリ名がURLに含まれることになるので、ふさわしい命名をすること。特にこだわりがなければ、officialにしておけばいい。リポジトリ名も後から変えられるので、先方から変更依頼があった場合は、変更する。

    (参考)

    GitHub Pagesでサイトを公開する場合、URLは以下のようになる。

    https://[Organization名].github.io/[リポジトリ名]/

    例)https://nogakujuku.github.io/official/

  4. ダウンロードしたフォルダはGitリポジトリになっていないので、ローカルでGitリポジトリにする。(手順詳細)

  5. 先方用のOrganizationを作る(既に作っている場合はステップ6へ)

  6. 作ったOrganizationで案件用のリポジトリを作る。リポジトリ名は手順3で作ったローカルのリポジトリと同じ名前にする。 **※必ずPublicリポジトリに設定する。あとでPrivateからPublicに再設定すると、Forkの接続が切れてしまう。Forkの接続が切れるとFork元リポジトリでContributor情報が消えてしまう!**それ以外はデフォルトの設定値で問題ない。

    農楽塾のOrganization画面

    農楽塾のOrganization画面

    リポジトリ名は手順3で作ったローカルのリポジトリと同じ名前にする

    リポジトリ名は手順3で作ったローカルのリポジトリと同じ名前にする

  7. 手順4で作ったローカルのGitリポジトリを手順6で作ったリモートのリポジトリにpushする(手順詳細) これにより、ローカルリポジトリとリモートリポジトリが接続される。

  8. リポジトリをForkする

    リポジトリ画面の右上の[Fork]をクリック

    ※cannot fork because forking is disabledと表示される場合

    画面は農楽塾のリポジトリ

    画面は農楽塾のリポジトリ

    Ownerとしてwinc1980を設定し、Repository nameを設定する。Repository nameはそのプロジェクトのリポジトリであることが分かる名前にする。例として、農楽塾の案件では「nogakujuku_official」という名前をつけた。このリポジトリ名はURLには現れないので、あまり拘らなくて良い。

    capture3.png

    Forkが完了すると以下のような画面になる。

    capture4.png

以上の手順で案件の開発用リポジトリを作ることができる。開発はこのリポジトリをクローンして行う。案件でForkしたリポジトリ上で開発する際の作業手順を書いたので、それに目を通してから開発を進めること