tmux/arl.gitmux
1
0
Fork 0
mirror of https://github.com/arl/gitmux.git synced 2026-09-10 07:26:18 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
arl.gitmux/.github/copilot-instructions.md
Aurélien Rainone 3d6516be61
Repository gardening (#131) 
* ci: remove brew tag check from workflow

* goreleaser: remove brew-specific configuration

* .github: improve pull request template

* .github: add copilot instructions
2025-07-31 11:47:06 +02:00

1.1 KiB
Raw Blame History

This is a Go based repository buliding a command line tool that converts the status of a git working tree for a specific directory into a tmux status string the end user can add to their tmux status line. It is designed to be used with the tmux terminal multiplexer.

Code Standards

Required Before Each Commit

  • Run go test ./... before committing any changes to ensure tests pass
  • Go code should be formatted with gofmt

Repository Structure

  • ./: repository root, main package, default configuration file, and main entry point
  • tmux/: tmux formatting
  • json/: used by gitmux -dbg to print the git working tree status as a json object, for debugging purposes
  • testdata/: testscripts fixtures when actual gitmux output is checked against some specific conditions.

Key Guidelines

  1. Follow Go best practices and idiomatic patterns
  2. Maintain existing code structure and organization
  3. Write unit tests for new functionality. Use table-driven unit tests when possible.
  4. Document public options
  5. Keep table aligned in the README.md file, for a nice experience even when reading the file in a terminal