Config: Add Go-Specific Review Instructions to .coderabbit.yaml

[coderabbitai]

Overview

golangci-lint is already enabled in .coderabbit.yaml, but there are no Go-specific path_instructions to guide CodeRabbit's review logic for .go files. This issue tracks adding a dedicated Go review instruction block to improve the quality and depth of reviews on AOSSIE's Go-based projects.

---

Proposed Change

Add the following block to the path_instructions section in .coderabbit.yaml:

path_instructions:
  - path: "**/*.go"
    instructions: |
      Go code review guidelines:

      **Naming & Style**
      - Follow Effective Go naming conventions (MixedCaps, not underscores).
      - Package names should be lowercase, single-word, and descriptive.
      - Exported functions, types, and variables must have godoc comments.

      **Error Handling**
      - Errors must not be silently ignored (no bare `_` discards for error returns).
      - Prefer wrapping errors with `fmt.Errorf("...: %w", err)` to preserve stack context.
      - Avoid `panic` except in truly unrecoverable situations; prefer returning errors.

      **Goroutine & Concurrency Hygiene**
      - Every goroutine must have a clear lifetime and ownership.
      - Ensure `sync.WaitGroup` or context cancellation is used to manage goroutine teardown.
      - Flag potential data races: shared state accessed from multiple goroutines without synchronization.
      - Prefer channels for communication over shared memory where appropriate.

      **Context Propagation**
      - Functions that perform I/O, network calls, or long computations should accept `context.Context` as the first parameter.
      - Ensure contexts are not stored in structs; pass them explicitly.
      - Check that context cancellation/deadlines are respected in loops and blocking calls.

      **Testing**
      - Prefer table-driven tests using `[]struct{...}` test case slices.
      - Test function names should follow the `TestFunctionName_Scenario` pattern.
      - Ensure test coverage for error paths and edge cases, not just happy paths.
      - Flag missing tests for exported functions.

      **Initialization**
      - Flag usage of `init()` functions unless there is clear justification (e.g., driver registration).
      - Prefer explicit initialization over side-effect imports.

      **Performance & Resource Management**
      - Ensure `defer` is used correctly for resource cleanup (files, mutexes, connections).
      - Flag unnecessary allocations inside hot loops.
      - Prefer pre-allocated slices (`make([]T, 0, n)`) when the size is known in advance.

      **Security**
      - Flag use of `unsafe` package and require justification.
      - Check for SQL injection risks in dynamically constructed queries.
      - Ensure sensitive data is not logged.

---

Acceptance Criteria

• .coderabbit.yaml updated with the above path_instructions block for **/*.go files.
• The template-sync.yml workflow propagates the updated config to child repos using this template.
• Verified that CodeRabbit applies the Go-specific instructions when reviewing .go files.

---

References

• CodeRabbit path-based instructions: https://docs.coderabbit.ai/guides/review-instructions
• Effective Go: https://go.dev/doc/effective_go
• golangci-lint: https://golangci-lint.run/

[Okd2006]

Hi, I’d like to work on this issue.

I can add the proposed Go-specific path_instructions block to the .coderabbit.yaml configuration so that CodeRabbit performs deeper and more structured reviews for *.go files. The instructions will guide CodeRabbit to evaluate important aspects of Go development such as naming conventions, proper error handling, goroutine lifecycle management, context propagation, testing practices, and security considerations.

After updating the configuration, I will also verify that the changes work correctly with the template-sync.yml workflow so that the updated rules propagate to child repositories using this template. Additionally, I will confirm that CodeRabbit applies these Go-specific instructions during reviews of .go files to ensure improved analysis quality for Go-based projects within the organization.

Please let me know if there are any additional Go review guidelines or project-specific rules that should be included before implementing the change.

[kpj2006]

consider to adding relevant minimal content according to our use cases avoid adding any additional ones.
this above issue generated by AI.
so the mentioned content should be manually reviewed before working.

[Okd2006]

Hi @kpj2006 i assure u i wont just be an ai pilot and deeply analyse the code and output before i create a pr

[kpj2006]

what about other issue @Okd2006, which i have assigned you ??

[Okd2006]

Hi @kpj2006 I have raised the PR for that.