Githubのリポジトリを作ってみた。

目次

・記事を書くきっかけ
・今回のゴール
・リポジトリを作る時の画面って...
・まず、日本語に翻訳してみよう！
・Repository(リポジトリ)とは
・所有者
・リポジトリ名
・説明 (オプション)
・公共(Public)orプライベート(Private)
・Add a README fileとは
・Add .gitignore
・ライセンスを選択する
・ライセンス:無し
・リポジトリを作成する
・READMEの書き方

記事を書くきっかけ

・各オプションの機能を理解せずにリポジトリを作っている事に気づく。

今回のゴール

・Swiftを使ってAtCoderで解いた問題を管理するリポジトリを作成する。
・AtCoder_Swiftというリポジトリ名にする。
・説明 (オプション)には以下の文を記載する。

Solving Atcoder problems in Swift.
(訳:SwiftでAtcoderの問題を解く。)

・公共(Public)orプライベート(Private)は、自分以外に見られたり、利用されても問題がないので公共(Public)を選ぶ。
・READMEを以下の内容で記述する。

・Add .gitignoreは記述するものが無いので記述しない。
・Choose a licenceはLicence:Noneを選択する。

リポジトリを作る時の画面って...

・英語だらけで不安を煽ってくるから日本語に翻訳してみる。

まず、日本語に翻訳してみよう！

・日本語に変換するだけそれぞれの設定のイメージがしやすくなる！
・何が理解できていないかが見えてくるので翻訳機能を活用してみよう！

Repository(リポジトリ)とは

・GitHubのリポジトリは、コードやプロジェクトファイルを格納し、バージョン管理を行い、共同で開発を進めるための場所。

英語で「貯蔵庫」、「倉庫」などを表す言葉で、一般用語としては、さまざまなデータ、情報、知識や成果物を蓄積するデータベースやアーカイブを指します。世の中には○○リポジトリ、××リポジトリといった分野別の大規模知識データベースやソフトウェアアーカイブが存在します。例えば、研究機関が研究成果や学術情報を蓄積する機関リポジトリやCVS（Concurrent Versions System）、SVN（Apache Subversion）、GitHubのようなバージョン管理機能を持つソースコード管理システムなどが有名です。

所有者

・所有者は誰が所有しているかという考え。
・変更する時は、自分以外の人と一緒に開発する人がいたりする時や会社所有の開発を始める時に変更する。（今回はしない）

リポジトリ名

・上記の写真に記載のある通り、理解しやすい名前にしておく。

説明 (オプション)

・以下の内容で記述する。

公共(Public)orプライベート(Private)

・ラジオボタンで公共を選択する。

Add a README fileとは

・プログラムの説明書のようなもの。どうやってプログラムを使うか、何に使えるかが書いてある。
・今回は、以下のchatGPTが教えてくれた内容で書いてみる。
・READMEを記入したい時はチェックをいれる。

READMEの記述する内容をchatGPTに聞いてみた

使用言語や技術
プロジェクトで使用しているプログラミング言語、ライブラリ、フレームワークなどの技術情報を記述します。

ディレクトリ構造
リポジトリ内のファイルやディレクトリの構造を説明し、どのファイルが何を担当しているかを示します。

使用法
もしプロジェクトに対する具体的な使い方やコントリビューションのガイドラインがある場合、それらを説明します。

ライセンス情報
プロジェクトのライセンス情報を明示します。GitHubの "Choose a license" ツールを使って選択することができます。

このような情報をREADMEに記述することで、他のユーザーがあなたのリポジトリを理解しやすくし、使い方や貢献方法がわかりやすくなります。また、コードのドキュメンテーションや解説も必要に応じて追加すると良いでしょう。

Add .gitignore(訳: .gitignore を追加する)

・.ignore（訳:無視する）

・.gitignoreファイルに特定のファイルやディレクトリを記述すると記述したファイルやディレクトリをGitによる管理から除外し、無視してもらえる。
・今回は、見せたくないファイルやディレクトリが無いので、設定しない。（デフォルトのままにする）

ライセンスを選択する(英:Choose a licence)

・GitHubの "Choose a license" ツールで "None" を選択した場合は、作成者がプロジェクトにライセンスを適用しないことを意味する。
・作成者以外がプロジェクトのコードやリソースを自由に使用、変更、再配布できることを意味する。
・ライセンスがない場合、法的な制約がほとんどないため、他の人はプロジェクトのコードを取得し、それを用途に合わせて利用できます。

ライセンス:無し(英:Licence:None)を選択するタイミング

・作成者が自分以外の他の人に対して、自分のプログラムやプロジェクトを自由に利用させ再配布させることを許可する場合に適している。
・この選択肢を選ぶことで、プログラムのライセンスに関する制約を設けずに、コードやリソースを広く共有できる。
・今回は、私が書いたコードを私以外に自由に利用させ再配布しても良いと考えているのでライセンス:無しを選択する。

リポジトリを作成する。

・リポジトリを作成するという緑のボタンを押すとリポジトリが完成。

READMEをVScodeで書く方法

・READMEをVScodeで書くにはgit cloneをする必要がある。
・GitHubのRepositoriesをクリックする。

・先ほど作成したAtCoder_Swiftをクリックする。

・右側にある<>　Code ▼緑のボタンをクリックする。
・SSHに、オレンジのアンダーラインが引かれているのを確認したら

・以下の画像の正方形が重なっているボタンをクリックするとURLがコピーされる。

・VScodeのターミナルでプログラムを管理したいディレクトリに移動する。
・ターミナルで以下のコマンドを入力する。

git clone （ここに先ほどコピーしたURLを貼る）

・作成者だけでリポジトリを管理する場合は以下の画像の右上にある鉛筆マークをクリックする編集できる。
・更新した内容を保存して、githubにpushする。