Conversation
Signed-off-by: strantalis <strantalis@virtru.com>
Summary of ChangesHello @strantalis, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces AGENTS.md, a new documentation file designed to provide clear and comprehensive repository guidelines for developers working on coding agents. The aim is to standardize development practices, ensuring consistency in project structure, build processes, coding style, testing, and contribution workflows, without introducing any functional changes to the codebase. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces AGENTS.md, a new documentation file containing repository guidelines for contributors, particularly aimed at coding agents. The guidelines are comprehensive, covering project structure, build commands, coding style, testing, and commit conventions. My review focuses on improving the clarity and maintainability of this new documentation. I've suggested removing a hardcoded Go version to prevent the document from becoming stale and proposed a clarification to the commit message guidelines to avoid potential confusion for contributors. Overall, this is a valuable addition to the project's documentation.
|
|
||
| ## Build, Test, and Development Commands | ||
|
|
||
| This repo is Go-first (module: `github.com/opentdf/otdfctl`) and pins a toolchain in `go.mod` (`go1.24.11`). |
There was a problem hiding this comment.
Hardcoding the Go toolchain version here makes the documentation brittle, as it can become outdated when go.mod is updated. To improve maintainability, I recommend removing the specific version and instead directing the reader to the go.mod file. I've also added backticks for consistency with the rest of the document.
| This repo is Go-first (module: `github.com/opentdf/otdfctl`) and pins a toolchain in `go.mod` (`go1.24.11`). | |
| This repo is Go-first (module: `github.com/opentdf/otdfctl`) and pins a toolchain in `go.mod`. |
|
|
||
| - Follow Conventional Commits as seen in history (e.g., `feat(core): …`, `fix(ci): …`, `chore(dependabot): …`; use `!` for breaking changes). | ||
| - DCO sign-off is required: `git commit -s -m "feat(core): …"`. | ||
| - PR titles are linted for semantic format: types `fix|feat|chore|docs` and scopes `main|core|tui|demo|ci|dependabot`. |
There was a problem hiding this comment.
The guidance on commit messages could be slightly confusing. Line 38 refers to 'Conventional Commits', which has a broad set of standard types, but this line restricts them to a smaller list for PR titles. To avoid ambiguity, I suggest clarifying that PR titles are linted against a specific subset of Conventional Commit types.
| - PR titles are linted for semantic format: types `fix|feat|chore|docs` and scopes `main|core|tui|demo|ci|dependabot`. | |
| - PR titles are linted for a specific semantic format, using a subset of Conventional Commit types: `fix|feat|chore|docs` and scopes `main|core|tui|demo|ci|dependabot`. |
jakedoublev
left a comment
jakedoublev
left a comment
There was a problem hiding this comment.
Suggestions should be reviewed, but otherwise LGTM
2 participants
Adds AGENTS.md with repository guidelines for coding agents.
No functional changes.