-
Notifications
You must be signed in to change notification settings - Fork 1.2k
chore: add rules for basic development guidance #13516
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,26 @@ | ||||||||||||
| # Java Bigtable Development Guidelines | ||||||||||||
|
|
||||||||||||
| When developing or modifying code within the `java-bigtable` directory, you must strictly follow these rules and perform these actions: | ||||||||||||
|
|
||||||||||||
| ## 1. Source Control | ||||||||||||
| - **Always** pull the latest changes from the `main` branch of `git@github.com:googleapis/google-cloud-java.git` before starting work. | ||||||||||||
| - Checkout a new branch for your development instead of committing directly to `main`. | ||||||||||||
|
|
||||||||||||
| ## 2. Unit Testing | ||||||||||||
| - **Always write unit tests** for any new logic or modifications you implement. | ||||||||||||
| - Follow **JUnit 5** conventions for writing and structuring tests (e.g., using `@Test`, `@BeforeEach`, etc., from `org.junit.jupiter.api`). | ||||||||||||
| - Do not use JUnit 4 unless modifying an existing file that hasn't been migrated yet, but for new tests default to JUnit 5. | ||||||||||||
|
|
||||||||||||
| ## 3. Clean Up Imports | ||||||||||||
| - After writing or updating code, **always** check that imports are properly cleaned up. | ||||||||||||
| - Avoid using fully qualified class names (e.g., `x.y.z.Class`) directly inline in the code. | ||||||||||||
| - Ensure all required classes are imported in the header of the Java file. | ||||||||||||
| - Remove any unused imports. | ||||||||||||
|
|
||||||||||||
| ## 4. Code Formatting | ||||||||||||
| - Automatically format the code using the `fmt-maven-plugin`. | ||||||||||||
| - Before finalizing your changes, run the following command in the terminal from the `java-bigtable` directory or the relevant module directory: | ||||||||||||
| ```bash | ||||||||||||
| mvn com.spotify.fmt:fmt-maven-plugin:format | ||||||||||||
| ``` | ||||||||||||
| - **Troubleshooting**: If the formatting command fails, it is usually because of an incompatible JDK version. Ensure you are running it in an environment with the correct JDK version for the project (typically 17+, depending on the project configuration). | ||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To align with the repository's documentation guidelines, please add a section clarifying that
Suggested change
References
|
||||||||||||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using the short-hand command
mvn fmt:formatis more concise and standard, as the plugin is already configured in the project's Maven configuration.