Skip to content
/ repo_template Public template

面倒だと思うその前にtemplateを作る

Notifications You must be signed in to change notification settings

S-Reo/repo_template

Repository files navigation

repo_template

面倒だと思うその前にtemplateを作りました.

Issue作成(各リポジトリごとにうまい具合に設定してください)

Project \ Issue improve bugfix
issue and improve Make Issue Make Issue

テンプレートとして使用したらはじめにすること

  1. readme.mdの修正,やらないと許さない

    # 置換対策のためにスペースを追加しています
    # コマンドで使用するときはとしてください
    $ sed -i -e "s%streamwest-1629 / repo_template%<username> / <reponame>%g" readme.md
  2. リポジトリの設定を変更

    1. Projectsの作成 make projects からissue and improveプロジェクトを作成します.Templateは Automated kanban が良いかと思います(楽なので).
    2. SettingsPull Requests から Automatically delete head branches の項目にチェックをつけてください.
  3. dockerfileの修正

    • ビルド・デプロイ用にdocker (compose)を用いることを前提に組まれている.
    • そのため,build.dockerfiledocker-compose.yml をうまい具合に書き直してほしい. (Future Feature: 新しい言語を触るときはその都度このリポジトリのどこかにプリセットとしておいておきたい)

    ちなみに,デフォルトではGolangを修正しやすいようにわざわざ build.dockerfile に記述している.

ブランチ運用ルール(Git-flowベースな感じ)

大前提として,およそ Issue > (fixing) > Pull request > (review) > mergeの順を守ってください

  • Issueに紐づいたブランチを作るときはIssueのDevelopmentからブランチを切る
    • Issueとブランチを紐づけて管理しやすくするため
  • コミット時には必ず先頭に #[Issue番号]: を付ける
    • Issueから追跡できるようにするため
  • ブランチ名に関しては下に示すものに加え,プロダクトに応じて release, staging, nightly などのブランチを用意しておく.

ブランチ命名規則とその運用

ブランチ名 運用方法 チェックアウト/マージ先
main 開発用ブランチ.
ここで直接作業を行わないでください.
(最上位格)
[Issue番号]-improve/[Issue説明] 機能実装系のIssueを裁く際のブランチ.
IssueのDevelopmentから作ると左記のようなブランチ名になるはず.
main
[Issue番号]-bugfix/[Issue説明] バグ修正系のIssueを裁く際のブランチ.
IssueのDevelopmentから作ると左記のようなブランチ名になるはず.
main
[Issueベース系ブランチ名]/hotfix main ブランチ以外で修正を行う必要があるときに使用するブランチ.
123-bugfix/緊急の修正/hotfix みたいな使い方をする.
任意のブランチ

About

面倒だと思うその前にtemplateを作る

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published