Skip to content

Conversation

metachris
Copy link
Contributor

No description provided.

@metachris metachris requested a review from Copilot September 18, 2025 17:18
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a new AGENTS.md file containing comprehensive development guidelines for the repository. The document provides structured guidance on project organization, build processes, coding standards, testing practices, and security considerations.

  • Establishes standardized development workflow with make targets for formatting, linting, and testing
  • Documents project structure including module organization and file placement conventions
  • Provides coding style guidelines and commit/PR best practices

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

- Confirm `make fmt`, `make lint`, and `make test` in PR checklists; ensure reviewers can reproduce your steps quickly.

## Security & Configuration Tips
- Maintain `basic-auth-hash.txt` outside version control; rotate secrets through the `/api/v1/set-basic-auth` endpoint.
Copy link
Preview

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding guidance on proper file permissions for basic-auth-hash.txt (e.g., 600 or 640) to prevent unauthorized access to authentication credentials.

Suggested change
- Maintain `basic-auth-hash.txt` outside version control; rotate secrets through the `/api/v1/set-basic-auth` endpoint.
- Maintain `basic-auth-hash.txt` outside version control; set file permissions to `600` or `640` to prevent unauthorized access; rotate secrets through the `/api/v1/set-basic-auth` endpoint.

Copilot uses AI. Check for mistakes.

## Coding Style & Naming Conventions
- Code is gofmt/gofumpt formatted with tabs; prefer explicit names (`eventStore`, `tlsCertPath`) and singular file names.
- Document exported symbols with concise GoDoc comments and keep configuration passed through structs instead of globals.
- Secrets, ports, and paths should be injected via config or env; never hardcode sensitive values.
Copy link
Preview

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This guideline should specify that environment variables containing secrets should be clearly documented and mention potential risks of environment variable exposure in process lists.

Suggested change
- Secrets, ports, and paths should be injected via config or env; never hardcode sensitive values.
- Secrets, ports, and paths should be injected via config or environment variables; never hardcode sensitive values. Environment variables containing secrets must be clearly documented, and note that such secrets may be exposed in process lists or logs—consider using configuration files or secret managers where possible.

Copilot uses AI. Check for mistakes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants