chore: add rules for basic development guidance - #13516
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new development guidelines document (SKILL.md) for the java-bigtable directory, covering source control, unit testing, import cleanup, and code formatting. The feedback suggests simplifying the formatting command to a more concise 'mvn fmt:format' and adding a section on building and installing snapshot artifacts with 'mvn install' to align with repository documentation guidelines.
| - 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 |
There was a problem hiding this comment.
Using the short-hand command mvn fmt:format is more concise and standard, as the plugin is already configured in the project's Maven configuration.
| mvn com.spotify.fmt:fmt-maven-plugin:format | |
| mvn fmt:format |
| ```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). |
There was a problem hiding this comment.
To align with the repository's documentation guidelines, please add a section clarifying that mvn install is used for building snapshot artifacts to the local ~/.m2 repository.
| - **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). | |
| - **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). | |
| ## 5. Building and Installing | |
| - Use mvn install to build snapshot artifacts to your local ~/.m2 repository. |
References
- In documentation about the Java build process, clarify that
mvn installis used for building snapshot artifacts to the local~/.m2repository.
mutianf
changed the title
2 participants
No description provided.