git-town / git-town

Git made easy for teams
https://www.git-town.com
MIT License
2.45k stars 105 forks source link

Git Town screencasts #3323

Open kevgo opened 2 months ago

kevgo commented 2 months ago

A series of short screencasts might help new users wrap their head around Git Town. It certainly would help me learn this tool if I didn't know it already.

  1. Installation and basic usage
    • set up Git Town on your computer, seeing the help screens
    • build a simple feature
    • create branch
    • sync a branch
      • dry-run first
      • verbose
    • sync all
    • create a proposal
    • ship using the web UI
    • sync to remove the local branch
  2. working with stacks
  3. branch types

Contributing to Git Town

  1. submit a PR containing an end-to-end test that reproduces a bug
  2. submitting a PR with a bug fix or feature
    • clone the codebase
    • install Go
    • install VSCode
    • VSCode Go plugin
    • run the various tests
    • run the website
    • walk through the codebase
    • walk through of the test framework
    • debug an E2E test: inspect the repo, inspect the commits
    • anatomy of a Git Town command: walk through what happens when Git Town executes a command
    • make a small change and submit the pull request
kevgo commented 2 months ago

possible technology to create animated GIFs: https://github.com/charmbracelet/vhs