docs(bigquery-jdbc): add developer and maintainer guide - #13879
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive developer and contributor guide (DEVELOPMENT.md) for the BigQuery JDBC module, detailing its architecture, developer guardrails, testing playbook, and logging conventions. The review feedback correctly identifies an absolute local file URI used in a link to the Makefile, which should be updated to a relative link to prevent leaking local environment details and ensure it works for other contributors.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
…loud-java into pr-2-developer-guide # Please enter a commit message to explain why this merge is necessary, # especially if it merges an updated upstream into a topic branch. # # Lines starting with '#' will be ignored, and an empty message aborts # the commit.
|
|
||
| ```bash | ||
| # Set GCP service account credentials | ||
| export GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account-key.json |
There was a problem hiding this comment.
note: add SA_SECRET/KMS_PATH/SA_EMAIL params as they're required for some tests
|
|
||
| ```bash | ||
| # Start an interactive shell session inside Docker container | ||
| make docker-session |
There was a problem hiding this comment.
make docker-build to build;
|
|
||
| ### Developer Logging Rules & Conventions | ||
|
|
||
| 1. **Method Entry / Exit Tracing**: |
There was a problem hiding this comment.
I thought it is done automatically for public interfaces? Probably worth mentioning it
|
|
||
| --- | ||
|
|
||
| ## 5. Pre-PR Checklist |
There was a problem hiding this comment.
Not sure about this..
if check is not automated, it is not enforceable.. For everything else we have presubmits.
abd7bb8
into
pr-1-user-guide-properties
b/538176465