Background

CI/CD is table stakes for professional teams. A green GitHub Actions pipeline proves you understand automated quality gates, caching, and how to keep main branch deployable.

Your mission

Add a GitHub Actions CI pipeline to a small existing project (yours or a fork). Every pull request should run install, lint, typecheck (if applicable), and tests before merge.

Requirements

1. Workflow triggers on pull_request and push to main (or default branch).
2. Jobs — at minimum: install dependencies, run test suite, run linter (ESLint, Ruff, etc.).
3. Typecheck — tsc --noEmit, mypy, or equivalent if the stack supports it.
4. Status badge in README linking to Actions tab.
5. Documented CI section in README: what runs, how to fix common failures, how to add a deploy job later.
6. Evidence — screenshot of a successful run + link to workflow file.

Recommended workflow structure

# Suggested stages (adapt to stack)
jobs:
  ci:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4  # or python, etc.
      - run: npm ci
      - run: npm run lint
      - run: npm run typecheck
      - run: npm test

Evaluation criteria

• Reliability — workflow passes on clean checkout; no flaky steps without explanation.
• Speed — reasonable caching (actions/cache or built-in package caches).
• Clarity — job names and step names readable in the Actions UI.
• Documentation — teammate could extend with deploy job using your README.

Tips

• Pin Node/Python version to match local dev (engines in package.json).
• Fail fast: lint before tests if tests are slow.
• Use repository secrets only for deploy — not needed for CI-only challenge.

Submission checklist

• Repo with .github/workflows/*.yml
• README CI section + badge
• Screenshot of green workflow run