Skip to content

chore: Add initial GEMINI.md file#3879

Merged
lqiu96 merged 5 commits intomainfrom
gemini-markdown-file
Aug 11, 2025
Merged

chore: Add initial GEMINI.md file#3879
lqiu96 merged 5 commits intomainfrom
gemini-markdown-file

Conversation

@lqiu96
Copy link
Member

@lqiu96 lqiu96 commented Aug 11, 2025

Attempt to generate a GEMINI.md file from the different README files located throughout the repo.

This is intended to be a first draft and new information and entries can be added and iterated upon.

@lqiu96 lqiu96 requested review from blakeli0 and zhumin8 August 11, 2025 14:26
@product-auto-label product-auto-label bot added the size: m Pull request size is medium. label Aug 11, 2025
@lqiu96 lqiu96 enabled auto-merge (squash) August 11, 2025 14:27

## 4. Testing

### 4.1. Testing Strategy
Copy link
Contributor

Choose a reason for hiding this comment

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

Does adding links to existing documentation pages work for gemini? I think we'd want to avoid maintaining extra copies if possible

Copy link
Member Author

@lqiu96 lqiu96 Aug 11, 2025

Choose a reason for hiding this comment

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

I have no idea. I wasn't able to find a concrete guide on what to include in here.

This is probably something we'll have to play around with and see over the coming weeks/ months.

@lqiu96 lqiu96 requested a review from zhumin8 August 11, 2025 15:28
GEMINI.md Outdated

## 5. Dependency Management

- Try not to bump any dependency version unless there is a known CVE (security or vulnerability issue)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think there are three main reasons to bump dependency versions

  • CVE
  • Critical bug fixes
  • Required new features

Copy link
Member Author

Choose a reason for hiding this comment

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

Adding the first two to the file. I think required new features may be a bit too vague. I can play around with the wording.

* If they are in `other modules(ast, model, writer etc.)`, you _must_ add traditional unit tests, you _may_ add golden unit tests to easily see the changes.
- If the changes are in both `gax` and `gapic-generator-java`, you _must_ add all test layers, including traditional unit tests, golden unit tests and showcase integration tests.

### 4.2. Running Unit Tests
Copy link
Contributor

Choose a reason for hiding this comment

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

Per run-gemini-cli, gemini.md is useful for "defining coding conventions, architectural patterns, or other guidelines the model should follow for a given repository".

Do we consider "the knowledge of how to run tests" beneficial to code reviews? I don't think it hurts either but I'm not sure there is a use case for it.

Copy link
Member Author

Choose a reason for hiding this comment

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

Do we consider "the knowledge of how to run tests" beneficial to code reviews?

Not for code reviews. This is more for generating code and to give gemini cli the context to try and generate the relevant test types. I'm not sure how well this will work (and we can add more or remove complete), but hopefully as we give better prompts and more context, gemini would be able to figure out which types of tests we want.

We do an non-traditional way of testing (comparing with golden tests) which maybe gemini can try and pick up on

Copy link
Contributor

Choose a reason for hiding this comment

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

This is more for generating code and to give gemini cli the context to try and generate the relevant test types

SG. This would be great if it works out!

@sonarqubecloud
Copy link

@sonarqubecloud
Copy link

Quality Gate Passed Quality Gate passed for 'java_showcase_integration_tests'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@lqiu96 lqiu96 merged commit c34e384 into main Aug 11, 2025
59 checks passed
@lqiu96 lqiu96 deleted the gemini-markdown-file branch August 11, 2025 17:56
lqiu96 added a commit that referenced this pull request Aug 21, 2025
Attempt to generate a `GEMINI.md` file from the different README files
located throughout the repo.

This is intended to be a first draft and new information and entries can
be added and iterated upon.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size: m Pull request size is medium.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants