Skip to content

Implement GitHub Workflow Standards Across All Repositories #8

@wonderwomancode

Description

@wonderwomancode

Summary

Implement the workflow standards documented in CONTRIBUTING.md across all AlternateFutures repositories.

Documentation Created

File Purpose
CONTRIBUTING.md Comprehensive workflow documentation
PULL_REQUEST_TEMPLATE.md PR template with checklist
feature_request.md Feature request template
bug_report.md Bug report template
task.md General task template

Key Standards

Branch Strategy

feature branches → dev → staging → main (production)

Branch Naming Convention

<type>/<issue-number>-<short-description>

Examples: feat/123-webauthn-passkeys, fix/456-jwt-refresh

Commit Message Format

<type>(<scope>): <subject>

Examples: feat(auth): add passkey authentication, fix(api): resolve rate limit bug

Environment Promotion

From To Requirements
Feature dev PR + CI pass
dev staging PR + CI pass
staging main PR + CI pass + 1 approval + QA verification

Implementation Checklist

Repository Setup

  • Configure branch protection rules on all repos
    • main: Require PR, 1+ approval, CI pass, no force push
    • staging: Require PR, CI pass, no force push
    • dev: Require PR, CI pass
  • Create dev and staging branches in all repos
  • Set default branch to dev for active development

Apply Templates to Repositories

  • service-auth
  • service-cloud-api
  • web-app.alternatefutures.ai
  • web-docs.alternatefutures.ai
  • package-cloud-cli
  • package-cloud-sdk
  • infrastructure-proxy
  • infrastructure-dns

CI/CD Workflows

  • Create pr-check.yml workflow template
  • Create deploy-dev.yml workflow template
  • Create deploy-staging.yml workflow template
  • Create deploy-prod.yml workflow template
  • Add security scan workflow

Labels Setup

Create standard labels across all repos:

  • Priority: priority: critical, priority: high, priority: medium, priority: low
  • Status: status: triage, status: accepted, status: in-progress, status: blocked
  • Type: type: bug, type: feature, type: enhancement, type: docs, type: security
  • Component: component: auth, component: api, component: app, component: cli, component: infra

Success Criteria

  • All repos have protected branches configured
  • Templates auto-apply to new issues and PRs
  • CI runs on all PRs
  • Environment promotion flow working
  • Team trained on new workflow

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions