github-design

GitHub Design Skill

Overview

Design GitHub repositories and workflows following best practices for organization, automation, and collaboration.

When to Use

• Setting up a new repository
• Creating or modifying GitHub Actions workflows
• Designing issue/PR templates
• Organizing labels and milestones
• Configuring branch protection
• Setting up GitHub Projects

.github Folder Structure

.github/
├── workflows/
│   ├── ci.yml                    # Main CI pipeline
│   ├── release.yml               # Release automation
│   └── reusable/
│       ├── build.yml             # Reusable build workflow
│       └── test.yml              # Reusable test workflow
├── ISSUE_TEMPLATE/
│   ├── config.yml                # Template chooser config
│   ├── bug_report.yml            # Bug report form
│   ├── feature_request.yml       # Feature request form
│   └── question.yml              # Question form
├── PULL_REQUEST_TEMPLATE.md      # PR template
├── CODEOWNERS                    # Code ownership
├── FUNDING.yml                   # Sponsorship links
├── dependabot.yml                # Dependency updates
├── labels.yml                    # Label definitions (for label sync)
└── SECURITY.md                   # Security policy

GitHub Actions Best Practices

Reusable Workflows

# .github/workflows/reusable/test.yml
name: Reusable Test

on:
  workflow_call:
    inputs:
      node-version:
        description: 'Node.js version'
        required: false
        type: string
        default: '20'
    secrets:
      NPM_TOKEN:
        required: false

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: ${{ inputs.node-version }}
          cache: 'npm'
      - run: npm ci
      - run: npm test

Calling Reusable Workflows

# .github/workflows/ci.yml
name: CI

on:
  push:
    branches: [main]
  pull_request:

jobs:
  test:
    uses: ./.github/workflows/reusable/test.yml
    with:
      node-version: '20'
    secrets: inherit