プロジェクトの資料やToDoをGitHubリポジトリで管理する上でテンプレート等使いやすい仕組みを最低限機能するようにしてみた

新規施策として立ち上げる上で、調査や検証等のToDo及び結果をどこにまとめるかは悩ましいところです。が、今はActionsというとても便利なものがあります。とりあえず全部GitHubリポジトリに突っ込むことにしました。
2021.09.29

新しいプロジェクトを立ち上げるにあたっての準備をリストアップしていましたが、単純なテキストに起こすのも融通が利きそうにありません。そこでGitHubリポジトリのIssuesを活用してみました。資料もあれば兎に角突っ込んでバージョン管理というノリです。

ただ、肝心なIssueはフリーテキストであり、方針無くしてフォーマット踏まえて書くのは大変面倒です。まずは空っぽのリポジトリを機能させるために準備として幾つかファイルをコミットしてみました。

ディレクトリの形成

忘れがちですが、初期設定では .github ディレクトリが存在しません。

mkdir .github/
mkdir .github/ISSUE_TEMPLATE/
mkdir .github/workflows/
mkdir docs/

Issues

当面は調査が主体です。そこで以下の内容にて追加してみました。パスは .github/ISSUE_TEMPLATE/report.yml としておきます。

---
name: [REPORT]
about: 調査や検証
title: ''
labels: 'report, documentation'
assignees: ''

---
## 目的


## 関連チケット


## 備考

Contributer Info

調査が主体であり、当面は実装が入ってきません。故に、「指針は存在しますよ」とだけ書いておきます。パスは docs/CONTRIBUTING.md です。

# Contribution Guide

リポジトリで活動するにあたり、コミットの精度が人によってまちまちになるのを防ぐための指針です。

以下TBD

Actions

textlintやConfluenceへの転写用Actionを入れる想定ですが、まずはworkflowそのもののlintを入れておきます。パスは .github/workflows/lint-actions.yml です。

name: "Test: GitHub Actions"

on:
  push:
    paths:
    - '.github/workflows/**'
    - '.github/actions/**'
  workflow_dispatch:

jobs:
  actionlint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Run actionlint
        shell: bash
        run: |
          bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/main/scripts/download-actionlint.bash)
          ./actionlint -color -shellcheck=

あとがき

普段はソースコードのリモート管理という一面で扱っているGitHubリポジトリですが、資料管理やテキスト精査等色々な使い方も可能です。資料やToDoがあちこちに分散して大変、という場合には思い切ってGitHubリポジトリに全部詰めてしまうのもありかもしれません。