Skip to content

Instantly share code, notes, and snippets.

@unicornware

unicornware/repo-setup.md

Last active March 9, 2024 22:10
Show Gist options
  • Save unicornware/1edc71320edd183fb6d7bcd12e565ff1 to your computer and use it in GitHub Desktop.
Save unicornware/1edc71320edd183fb6d7bcd12e565ff1 to your computer and use it in GitHub Desktop.
Download ZIP
Repo Setup
Raw
repo-setup.md

Repo Setup

  1. Local setup
    • Replace project-name with project name (don't forget to skip this line 😉)
      • Run yarn afterwards to update lockfile
    • Commit scopes
      • Update .commitlintrc.*
    • Variables
      • Update .env.repo
      • Update .env.vars
    • Infrastructure
      • Update .github/infrastructure.yml
    • Package details
      • Update package.json#author
      • Update package.json#description
      • Update package.json#keywords
      • Update package.json#license
      • Review package.json#publishConfig
    • Preliminary documentation
      • Review CONTRIBUTING.md
      • Update README.md
      • Update LICENSE.md
    • Release management
      • Update grease.config.json
    • Review Yarn configuration
      • .yarnrc.yml
        • Update .github/workflows/ environments and permissions
  2. yarn check:ci
  3. init-repo
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment