はじめに
チーム開発や業務で「issueって何を書けばいいの？」と悩んだことはありませんか？
この記事では、Djangoの環境構築を例に、実務で役立つissueの書き方とその意味を丁寧に解説します。
issueとは？
一言でいうと「ドキュメント化された作業依頼」。
誰が・いつ・どの環境でやっても同じ成果が出せるように、情報を構造化して記録することが目的です。
Django環境構築：issueテンプレ例とその意味
✅ issue 発行時のチェック事項
作業に入る前に整えておくべき前提条件。発行者が書く部分です。
- [ ] リポジトリにアクセスできること（clone可能）
- [ ] Python 3.10 以上が使えること
- [ ] 仮想環境（venv）が作成・有効化できること
- [ ] .env ファイルが共有されていること（必要な場合）
- [ ] mainブランチにpushできる権限・設定があること
✅ 概要・背景
「何をやるのか」「なぜやるのか」をざっくり伝える部分。
## 概要
- Djangoプロジェクトの初期構築とrunserverによる起動確認を行う
## 背景
- 環境構築の標準化と再現性を高めるため
✅ 完了条件
何ができれば「完了」と言えるかの基準。
- [ ] Djangoのrunserverで開発サーバーが起動する
- [ ] /admin にアクセスし、ログインできる
- [ ] mainブランチにソースコードがpushされている
✅ 仕様（＝Howのルール）
どんな技術・構成で作業を進めるか。ルールや制約。
- Python 3.10 / Django 4.2（LTS）
- DBはSQLiteを使用
- 認証はDjango標準のスーパーユーザーで行う
✅ 影響範囲
この作業が影響を及ぼす範囲を明示。
- プロジェクト全体の開発基盤
- 今後の機能開発の土台
- settings.py, urls.py などの初期設定ファイル
✅ テスト方法・観点
完了条件をどうやって確認するか。確認手順と視点。
- [ ] http://127.0.0.1:8000/ にアクセスしてロケットマークが表示される
- [ ] `python manage.py createsuperuser` で作成したユーザーで /admin にログインできる
- [ ] GitLab/GitHub の main にcommitが反映されている
✅ 実装手順
予定している作業の手順。
1. リポジトリをclone
2. 仮想環境を作成し、有効化
3. Djangoをインストール
4. プロジェクト作成と設定
5. マイグレーション実行
6. スーパーユーザー作成
7. runserverで起動確認
8. Gitにcommit → mainへpush
✅ 実装手順とのずれ
「手順通りにいかなかったこと」があれば記録する。再発防止や引き継ぎのため。
- requirements.txt に不足パッケージがあり、Djangoを個別インストールした
- PostgreSQLへの切り替えが必要だったため、settings.py を調整した
✅ エビデンス
「ちゃんとできましたよ」の証拠。
- runserver実行画面のスクショ
- /admin ログイン後のスクショ
- GitHub上のcommit URL
おわりに
issueは単なる「作業メモ」ではなく、チームの共通言語・再現可能な設計図です。
特に環境構築のような再現性が重要な作業では、きちんと書かれたissueが未来の自分や仲間を助けてくれます。
ぜひ、自分のプロジェクトでもテンプレ化して使ってみてください！
Webエンジニアを募集中
私の所属する日本システム技研では、Webエンジニアを募集しています。
興味のある方は、ぜひ求人情報をご覧ください。