📋

issue参加用 手順書「GitHubでプログラミング力を一緒に高めよう!」

に公開

はじめに

エンジニアとしての基礎力を気軽に磨ける取り組みとして、
勤めている会社で「チャレンジ課題」企画をスタートしました。
この企画では、GitHubIssue(イシュー) に公開された課題に対して、
各自が自由な言語でプログラムを作成し、Pull Request(PR) を通じて提出・レビューを受ける流れになっています。

Issueとは?
GitHub上で「課題」や「タスク」などを共有・管理するための機能です。
チケットのように扱うことができ、進捗の記録やコメントでの議論も可能です。

この手順は、実際の OSS(オープンソースソフトウェア) 開発と同じ進め方でもあるため、今回はその流れを記事としてまとめてみました。

OSSとは?
OSS(オープンソースソフトウェア) とは、
ソースコードが誰でも自由に閲覧・利用・改良できるように公開されているソフトウェアのことです。

目的・準備

目的

この手順書は、Issueに参加し、プルリクエスト(PR)を提出するまでの流れをまとめたものです。

必要な準備

  • GitHubアカウントを持っている
  • GitがPCにインストールされている
  • ターミナル(またはGit Bash)が使える

手順

1.GitHubでリポジトリをForkする

  1. issueのリポジトリのURLを開く。
    https://github.com/ryuta-hiruma/challenge-tasks
  2. 画面右上の Fork ボタンをクリック。
  3. copy the main branch onlyをチェックいれて「Create fork」ボタンをクリック
  4. 自分のアカウントにコピーされます。

2.Forkしたリポジトリをcloneする

  1. 自分のPCにクローン用のフォルダを作成
  2. ターミナル(またはGit Bash)を開いて、作成したフォルダに移動
  3. GitHubで Fork した自分のリポジトリのページにアクセスします
    例:https://github.com/あなたのユーザー名/challenge-tasks
  4. ページ上部の緑色の Code ボタンをクリックして、HTTPSのURLをコピーします
  5. ターミナルでGitHubからリポジトリをcloneします(URLの部分に手順4のコピーしたものを張り付け)
git clone https://github.com/あなたのユーザー名/challenge-tasks.git

3. 課題用のブランチを作成

git checkout -b feature/ユーザー名_課題名

4. プログラムを作成・コミット・Push

# 例)ファイルを追加・修正後
git add .
git commit -m "JAVAでプログラム作成"
git push origin feature/ユーザー名_課題名

5. GitHub上でPull Requestを作成する

  1. GitHubに戻ると「Compare & pull request」ボタンが表示されるので押下
  2. 課題リポジトリに対して作成したfeature/ユーザー名_課題名ブランチをPRするための設定をする

➀課題リポジトリを選択
➁mainブランチを選択
➂自分のforkしたリポジトリを選択
➃実装をしたfeature/ユーザー名_課題名を選択

  1. タイトルを入力して「Create pull request」ボタンを押下

6. レビューを受ける

Pull Request(PR)を作成したら、あとはレビューを待ちましょう!

最後に

このチャレンジ課題は、エンジニアとしてのスキルアップだけでなく、
OSS開発のプロセスを体験できる良い機会でもあります。

  • GitHubの活用方法(Fork、PR、レビュー対応)
  • 自主的なプログラミング実践
  • 社内外への自己研鑽アピール

など、得られるものがたくさんあるので、ぜひ気軽に挑戦してみてくださいね

Discussion