snazy commented on code in PR #884: URL: https://github.com/apache/polaris/pull/884#discussion_r1930478637
########## CONTRIBUTING.md: ########## @@ -100,3 +99,12 @@ The Apache Polaris build currently requires Java 21 or later. There are a few to * [SDKMAN!](https://sdkman.io/) follow the installation instructions, then run `sdk list java` to see the available distributions and versions, then run `sdk install java <identifer from list>` using the identifier for the distribution and version (>= 21) of your choice. * [jenv](https://www.jenv.be/) If on a Mac you can use jenv to set the appropriate SDK. +## Good Practices + +* Change of public interface (or more generally speaking Polaris extension point) should be discussed and approved on the dev mailing list. + The discussion on the dev mailing list should happen before any change Pull Request. +* Using git (`git log`), you can find the original authors of the code you are modifying. If you need, feel free to tag the author in your Pull Request comment if you need assistance or review. +* Use a single Pull Request related to the same changes: don't close a Pull Request to create another one. The purpose here is to keep the history and all comments in the Pull Request. Review Comment: ```suggestion * Do not re-create a pull-request for the same change. Use one Pull Request related to the same change(s). The purpose here is to keep the history and all comments in the Pull Request. ``` ########## CONTRIBUTING.md: ########## @@ -100,3 +99,12 @@ The Apache Polaris build currently requires Java 21 or later. There are a few to * [SDKMAN!](https://sdkman.io/) follow the installation instructions, then run `sdk list java` to see the available distributions and versions, then run `sdk install java <identifer from list>` using the identifier for the distribution and version (>= 21) of your choice. * [jenv](https://www.jenv.be/) If on a Mac you can use jenv to set the appropriate SDK. +## Good Practices + +* Change of public interface (or more generally speaking Polaris extension point) should be discussed and approved on the dev mailing list. + The discussion on the dev mailing list should happen before any change Pull Request. Review Comment: ```suggestion The discussion on the dev mailing list should happen before having a "ready-for-review" Pull Request. ``` Draft-PRs can help to illustrate the intended change. ########## CONTRIBUTING.md: ########## @@ -100,3 +99,12 @@ The Apache Polaris build currently requires Java 21 or later. There are a few to * [SDKMAN!](https://sdkman.io/) follow the installation instructions, then run `sdk list java` to see the available distributions and versions, then run `sdk install java <identifer from list>` using the identifier for the distribution and version (>= 21) of your choice. * [jenv](https://www.jenv.be/) If on a Mac you can use jenv to set the appropriate SDK. +## Good Practices + +* Change of public interface (or more generally speaking Polaris extension point) should be discussed and approved on the dev mailing list. + The discussion on the dev mailing list should happen before any change Pull Request. +* Using git (`git log`), you can find the original authors of the code you are modifying. If you need, feel free to tag the author in your Pull Request comment if you need assistance or review. Review Comment: ```suggestion * `git log` you can help you find the original/relevant authors of the code you are modifying. If you need, feel free to tag the author in your Pull Request comment if you need assistance or review. ``` ########## CONTRIBUTING.md: ########## @@ -100,3 +99,12 @@ The Apache Polaris build currently requires Java 21 or later. There are a few to * [SDKMAN!](https://sdkman.io/) follow the installation instructions, then run `sdk list java` to see the available distributions and versions, then run `sdk install java <identifer from list>` using the identifier for the distribution and version (>= 21) of your choice. * [jenv](https://www.jenv.be/) If on a Mac you can use jenv to set the appropriate SDK. +## Good Practices + +* Change of public interface (or more generally speaking Polaris extension point) should be discussed and approved on the dev mailing list. + The discussion on the dev mailing list should happen before any change Pull Request. +* Using git (`git log`), you can find the original authors of the code you are modifying. If you need, feel free to tag the author in your Pull Request comment if you need assistance or review. +* Use a single Pull Request related to the same changes: don't close a Pull Request to create another one. The purpose here is to keep the history and all comments in the Pull Request. +* Consider all comments in your Pull Request, provide replies and resolve all pending comments. Review Comment: ```suggestion * Consider open questions and concerns in all comments of your Pull Request, provide replies and resolve addressed comments, if those don't serve reference purposes. ``` -- 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]
