[PECO-AI] PECOBLR-3873: [databricks-jdbc] Clarify single-test command in CONTRIBUTING.md - #1644
Draft
prathamesh-db wants to merge 1 commit into
Draft
[PECO-AI] PECOBLR-3873: [databricks-jdbc] Clarify single-test command in CONTRIBUTING.md#1644prathamesh-db wants to merge 1 commit into
prathamesh-db wants to merge 1 commit into
Conversation
Signed-off-by: Prathamesh Baviskar <prathamesh.baviskar@databricks.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PECO Agent Workflow (Partner Ecosystem)
Jira Ticket: https://databricks.atlassian.net/browse/PECOBLR-3873
Changes
Added a single-test documentation bullet to the
## Testingsection ofCONTRIBUTING.md. The new bullet immediately follows the existing WireMock integration-testing bullet and provides the Maven command for running a specific test method. No source code, test files, or changelog entries were modified, as this is a docs-only change (NO_CHANGELOG=true).Test Cases Written
None — this is a documentation-only change.
Contribution Guidelines
Contributing to Databricks JDBC Driver
We happily welcome contributions to the Databricks JDBC Driver. We use GitHub Issues
to track community reported issues and GitHub Pull Requests for
accepting changes. We are excited to work with the open source communities in the many years to come to improve the JDBC Driver.
Communication
We will make sure no one else is already working on it and ask you to open a GitHub issue.
user-facing behavior.
agreement on design.
linked to from the issue and hosted in a world-readable location.
please create an issue or create a pull request.
Contribution Workflow
Code contributions—bug fixes, new development, test improvement—all follow a GitHub-centered workflow. To participate in
Databricks JDBC Driver development, set up a GitHub account. Then:
Fork the repo. Go to the project repo page and use the Fork button. This will create a copy of the repo, under your
username. (For more details on how to fork a repository see this guide.)
Clone down the repo to your local system.
Create a new branch to hold your work.
Work on your new code. Write tests and run the Spotless code formatting plugin. The Spotless plugin also runs
automatically during the build process.
mvn test mvn spotless:applyCommit your changes.
git add -A git commit -s -m "Commit Message"Push your changes to your GitHub repo.
Open a Pull Request (PR). Go to the original project repo on GitHub. There will be a message about your recently
pushed branch, asking if you would like to open a pull request. Follow the prompts, compare across repositories, and
submit the PR. This will email the committers. You may want to consider sending an email to the mailing list for more
visibility. (For more details, see the GitHub guide on PRs.)
Maintainers and other contributors will review your PR. Please participate in the conversation, and try to make any
requested changes. Once the PR is approved, the code will be merged.
Additional git and GitHub resources:
Git documentation
Git development workflow
Resolving merge conflicts
Development Environment Setup
We recommend using IntelliJ to develop the Databricks JDBC Driver. You can download the community edition here.
Once you have IntelliJ installed, open the Databricks JDBC Driver project by selecting
File -> Openand selecting thedatabricks-jdbcfolder. Ensure that you have the Maven plugin loaded.Please run the following command after cloning the repository:
Debugging
The Databricks JDBC Driver uses both SLF4J and JUL
logging framework. By default, the driver uses the JUL logging framework. For more information on logging, refer to the
repository's README.md.
The easiest and recommended way to enable debug logging is via JDBC URL which will automatically use the JUL logging
framework. This will send the logs to the file pattern
databricks_jdbc.log.%iunder the specifiedLogPath.Note that when running the repository tests using maven or editor, logs will be printed to the console as per the
logging.propertiesinsrc/test/resources.Testing
extension built on WireMock, which helps simulate production-like environments while reducing
reliance on live systems. This approach improves CI/CD efficiency. For more details on the testing framework, refer to
the repository's README.md.
Coding Style
Developer Certificate of Origin
To contribute to this repository, you must sign off your commits to certify that you have the right to contribute the
code and that it complies with the open source license.
You can easily do this by adding a "Signed-off-by" line to your commit message to certify your compliance. Please use
your real name as pseudonymous/anonymous contributions are not accepted.
If you set your
user.nameanduser.emailgit configs, you can sign your commit automatically with git commit -s:This PR was generated by PECO Agent Workflow. Please review before merging.