-
Notifications
You must be signed in to change notification settings - Fork 3
Added codex-generated AGENTS.md #16
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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. |
There was a problem hiding this comment.
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.
- 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. |
There was a problem hiding this comment.
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.
- 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.
No description provided.