chore: add readme for google-cloud-bigquery-jdbc

[keshavdandeva]

b/474642014

Add README.md for google-cloud-bigquery-jdbc

[gemini-code-assist]

Summary of Changes

Hello @keshavdandeva, I'm Gemini Code Assist¹! 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 README.md file for the google-cloud-bigquery-jdbc module. This addition significantly enhances the project's documentation, providing a central and comprehensive resource for users and contributors to quickly understand how to get started, develop, test, and deploy the BigQuery JDBC client. The new README aims to improve developer experience by consolidating crucial information in one accessible location.

Highlights

• New README.md Added: A comprehensive README.md file has been added to the google-cloud-bigquery-jdbc module, providing essential documentation for developers and users.
• Quickstart and Installation Guide: The new README includes detailed instructions for quick setup using Maven, Gradle, and SBT, along with prerequisites and installation steps for the BigQuery JDBC client.
• Developer and Testing Information: A dedicated developer guide covers prerequisites, setup, running unit and integration tests (including Dockerized environments), packaging options (thin and full jars), custom query testing, night builds, performance tests, and code coverage.
• Comprehensive Operational Details: Important sections on authentication, authorization, supported Java versions, troubleshooting, versioning, contributing guidelines, licensing, and CI status have been included to provide a complete overview of the project.

🧠 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 Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces the README.md file for the google-cloud-bigquery-jdbc project. The README covers essential aspects such as quickstart instructions, authentication, authorization, a developer guide, packaging details, and supported Java versions. While the content is comprehensive, there are several areas that require attention to improve accuracy, clarity, and maintainability. These include version inconsistencies in dependency declarations, several typos, an incorrect example command for integration tests, and the presence of internal Google URLs that should not be in a public-facing document. Addressing these points will significantly enhance the quality and usefulness of the documentation.

[gemini-code-assist]

This URL points to an internal Google Storage location (pantheon.corp.google.com). This should not be present in a public README. Please remove this link and the associated descriptive text, or replace it with a public-facing alternative if one exists.

Suggested change

	Nightly Integration Tests include a step to build a full and thin jars and upload them to [Google Storage](https://pantheon.corp.google.com/storage/browser/bq_devtools_release_private/drivers/jdbc;tab=objects?inv=1&invt=Ab4E6g&project=bigquery-devtools-drivers&prefix=&forceOnObjectsSortingFiltering=false).
	Nightly Integration Tests include a step to build a full and thin jars and upload them to Google Storage.

[gemini-code-assist]

This URL points to an internal Cloud Build Pipeline (pantheon.corp.google.com). This should not be present in a public README. Please remove this link and the associated descriptive text, or replace it with a public-facing alternative if one exists.

Suggested change

	[Cloud Build Pipeline](https://pantheon.corp.google.com/cloud-build/triggers;region=us-east1/edit/125214da-8603-449d-8336-b6dba7196bb4?project=bigquery-devtools-drivers)
	is uploading latest full jar to the internal location for perf tests once a week, at the moment scheduled to do this Sunday night.
	Performance tests are uploading latest full jar to the internal location for perf tests once a week, at the moment scheduled to do this Sunday night.