diff --git a/.gitignore b/.gitignore index 92a217d..0393899 100644 --- a/.gitignore +++ b/.gitignore @@ -24,6 +24,7 @@ qodana.yaml # Output of the go coverage tool, specifically when used with LiteIDE *.out +*.html genhtml # Dependency directories (remove the comment below to include it) diff --git a/AGENTS.md b/AGENTS.md index f3f630c..bffb4a8 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -5,6 +5,7 @@ Focus mostly on given tasks, avoid unnecessary complexity. Since developers may Follow developers instruction first, don't update existing codes unless developer asked explicitly. ## Commands + - **Build**: `go build ./...` or `bazel build //...` - **Test (All)**: `go test ./...` or `bazel test //...` - **Test (Single)**: `go test -v ./pkg/path -run TestName` @@ -12,6 +13,7 @@ Follow developers instruction first, don't update existing codes unless develope - **Update Bazel**: `bazel run //:gazelle` (Run this after adding/removing files or imports) ## Code Style + - **Formatting**: Ensure code is formatted with `go fmt`. - **Naming**: Use camelCase for multi-word packages, directories, and filenames (e.g., `channelBanner`, `i18nRegion`). - **Headers**: Run `addlicense -c "eat-pray-ai & OpenWaygate" -f LICENSE -s=only -ignore "**/*.yml" -ignore "**/*.yaml" -ignore "**/*.bazel" .` to add headers. @@ -20,6 +22,7 @@ Follow developers instruction first, don't update existing codes unless develope - **Commits**: Follow [gitmoji](https://gitmoji.dev) convention. ## Structure + - **CLI Commands**: Located in `cmd//`. - **Core Logic**: Located in `pkg//`. - **Tests**: Co-located with code in `pkg/` as `_test.go`.