From 99262e2dfcfce69af64237d0624ef9f95c20f792 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?JB=20Onofr=C3=A9?= Date: Thu, 30 Jan 2025 14:39:17 +0100 Subject: [PATCH] Add "Good Practices" section in the contributing guide (#884) * Add "Good Practices" section in the contributing guide * Update CONTRIBUTING.md Co-authored-by: Robert Stupp * Update CONTRIBUTING.md Co-authored-by: Robert Stupp * Update CONTRIBUTING.md Co-authored-by: Robert Stupp * Update CONTRIBUTING.md Co-authored-by: Robert Stupp * Update CONTRIBUTING.md Co-authored-by: Robert Stupp --------- Co-authored-by: Robert Stupp --- CONTRIBUTING.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8652a2b88..1ecae255d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,6 @@ If you're looking for a feature that doesn't exist in Apache Polaris, you're pro When creating your feature request, document your requirements first. Please, try to not directly describe the solution. - ## Before you begin contributing code ### Review open issues and discuss your approach @@ -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 ` 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 having a "ready-for-review" Pull Request. +* `git log` 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. +* 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. +* 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. +* Give time for review. For instance two working days is a good base to get first reviews and comments. +* If you have the feeling that the discussions in a Pull Request are not going to a consensus, feel free to bring the discussion on the dev mailing list.