chore: add AGENTS.md #324
chore: add AGENTS.md #324
Conversation
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 a new 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 adds a new AGENTS.md file containing repository guidelines for developers. The document is well-structured and provides valuable information on project setup, build processes, coding standards, and contribution workflows. My review includes a few suggestions to enhance the clarity and completeness of the documentation. A key point of feedback is the filename AGENTS.md, which is unconventional for this type of content. Consider renaming it to something more descriptive like DEVELOPER_GUIDELINES.md or merging its content into the existing CONTRIBUTING.md to improve discoverability.
| ## Project Structure & Modules | ||
|
|
||
| - Multi-module Maven repo (root `pom.xml`) with three modules: | ||
| - `sdk/`: the OpenTDF Java SDK (`sdk/src/main/java`, `sdk/src/main/kotlin`, tests in `sdk/src/test/java`) |
There was a problem hiding this comment.
For completeness, it would be beneficial to also mention the Kotlin test source directory, sdk/src/test/kotlin. The build is configured to compile Kotlin test sources, so including it here would provide a more accurate picture of the project structure.
| - `sdk/`: the OpenTDF Java SDK (`sdk/src/main/java`, `sdk/src/main/kotlin`, tests in `sdk/src/test/java`) | |
| - `sdk/`: the OpenTDF Java SDK (`sdk/src/main/java`, `sdk/src/main/kotlin`, tests in `sdk/src/test/java` and `sdk/src/test/kotlin`) |
|
|
||
| ## Testing Guidelines | ||
|
|
||
| - Tests use JUnit (Jupiter) plus Mockito/AssertJ; place new tests under `sdk/src/test/java` and name `*Test`. |
There was a problem hiding this comment.
To be consistent with the project structure that includes Kotlin sources, it's a good idea to mention that new tests can also be placed in sdk/src/test/kotlin.
| - Tests use JUnit (Jupiter) plus Mockito/AssertJ; place new tests under `sdk/src/test/java` and name `*Test`. | |
| - Tests use JUnit (Jupiter) plus Mockito/AssertJ; place new tests under `sdk/src/test/java` or `sdk/src/test/kotlin` and name `*Test`. |
| ## Commit & Pull Request Guidelines | ||
|
|
||
| - Use Conventional Commits (enforced on PR titles): `feat(sdk): ...`, `fix(cmdline): ...`, `chore(docs): ...` (use `!` for breaking changes). | ||
| - DCO sign-off is required: `git commit -s`. |
There was a problem hiding this comment.
To help contributors find more detailed information about the DCO sign-off process, consider adding a link to the CONTRIBUTING.md file.
| - DCO sign-off is required: `git commit -s`. | |
| - DCO sign-off is required: `git commit -s`. See [CONTRIBUTING.md](CONTRIBUTING.md) for details. |
|
|
||
| ## Security & Configuration Tips | ||
|
|
||
| - Builds require the `buf` CLI (see `sdk/buf.yaml` / `sdk/buf.gen.yaml`). Authenticate to avoid rate limits; CI uses `BUF_INPUT_HTTPS_USERNAME`/`BUF_INPUT_HTTPS_PASSWORD`. Never commit tokens. |
There was a problem hiding this comment.
The use of a slash in BUF_INPUT_HTTPS_USERNAME/BUF_INPUT_HTTPS_PASSWORD might be ambiguous and could be misinterpreted as a single value. It would be clearer to explicitly state that these are two separate environment variables.
| - Builds require the `buf` CLI (see `sdk/buf.yaml` / `sdk/buf.gen.yaml`). Authenticate to avoid rate limits; CI uses `BUF_INPUT_HTTPS_USERNAME`/`BUF_INPUT_HTTPS_PASSWORD`. Never commit tokens. | |
| - Builds require the `buf` CLI (see `sdk/buf.yaml` / `sdk/buf.gen.yaml`). Authenticate to avoid rate limits; CI uses `BUF_INPUT_HTTPS_USERNAME` and `BUF_INPUT_HTTPS_PASSWORD`. Never commit tokens. |
|
X-Test Failure Report |
X-Test Results✅ js-v0.4.34 |
No description provided.