Fokko commented on code in PR #86: URL: https://github.com/apache/parquet-site/pull/86#discussion_r1833338138
########## content/en/docs/Contribution Guidelines/contributing.md: ########## @@ -31,6 +31,30 @@ A pull request can be merged through the GitHub UI. By default, only [squash and When the PR solves an existing issue, ensure that it references the issue in the Pull-Request template `Closes #1234`. This way the issue is linked to the PR, and GitHub will automatically close the relevant issue when the PR is being merged. +### Semantic versioning + +Parquet-Java leverages [semantic versioning](https://semver.org/#semantic-versioning-200) to ensure compatibility for developers and users of the libraries as APIs and implementations evolve. The Maven plugin [`japicmp`](https://github.com/siom79/japicmp) enforces this, and will fail when an API is being changed without going through the correct deprecation cycle. This includes for all the modules, excluding: `parquet-benchmarks`, `parquet-cli`, `parquet-tools`, `parquet-format-structures`, `parquet-hadoop-bundle` and `parquet-pig-bundle`. + +All interfaces, classes, and methods targeted for deprecation must include the following: + +- `@Deprecated` annotation on the appropriate element +- `@depreceted` javadoc comment including: the version for removal, the appropriate alternative for usage +- Replacement of existing code paths that use the deprecated behavior + +```java +/** + * @param c the current class + * @return the corresponding logger + * @deprecated will be removed in 2.0.0; use org.slf4j.LoggerFactory instead. + */ +@Deprecated +public static Log getLog(Class<?> c) { + return new Log(c); +} +``` + +Checking for any voilations can be done by running `mvn verify`. Review Comment: Hey Gang, good catch, I agree that it is a bit strong. I've changed it into: ``` Checking for API violations can be done by running `mvn verify -Dmaven.test.skip=true japicmp:cmp`. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
