Repository gardening (#131)

* ci: remove brew tag check from workflow

* goreleaser: remove brew-specific configuration

* .github: improve pull request template

* .github: add copilot instructions

Author: arl

.github/copilot-instructions.md

@@ -0,0 +1,23 @@
+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

.github/pull_request_template.md

@@ -2,6 +2,14 @@
 _Describe the problem or feature in addition to a link to the issues._
 
 ## Approach
-_How does this change address the problem?_
+_How does this Pull Request address the problem?_
 
-Thank you!
+## Testing
+
+ - There should be some unit tests for every behaviour change or new feature
+ - If you're adding a new configuration option, the default configuration file
+   (.gitmux.yml) should be modified with the new option
+ - There's a test that verifies that gitmux output always remains the same
+   across versions when using the default configuration. You can run it with:
+  `go test -run TestScriptst`
+ - `README.md` should always be updated.

.github/workflows/ci-cd.yaml

@@ -35,17 +35,3 @@ jobs:
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-
-  check_brew:
-    name: Check Brew Tap
-    needs: goreleaser
-    runs-on: macos-latest
-    steps:
-      - name: Install gitmux with brew
-        run: |
-          brew tap arl/arl
-          brew install gitmux
-          gitmux -V
-      - name: Check installed gitmux version
-        run: |
-          [ v$(gitmux -V) == "$GITHUB_REF_NAME" ]

.goreleaser.yml

@@ -31,20 +31,3 @@ changelog:
     exclude:
       - "^docs:"
       - "^test:"
-
-brews:
-  - name: gitmux
-    homepage: "https://github.com/arl/gitmux"
-    description: "Git in your tmux status bar."
-    license: "MIT"
-    url_template: "https://github.com/arl/gitmux/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
-    commit_msg_template: "Brew formula update for {{ .ProjectName }} version {{ .Tag }}"
-    directory: Formula
-    skip_upload: false
-    repository:
-      owner: arl
-      name: homebrew-arl
-      branch: main
-    commit_author:
-      name: goreleaser-bot
-      email: [email protected]