This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new f9a21656d Add content to contributing guidelines. (#2536)
f9a21656d is described below
commit f9a21656da370818e63dcfbf02843d705e0fa950
Author: JB Onofré <jbono...@apache.org>
AuthorDate: Thu Sep 18 07:58:00 2025 +0200
Add content to contributing guidelines. (#2536)
Add community guidelines.
---
CONTRIBUTING.md | 11 +++++++-
site/content/community/community-guidelines.md | 39 ++++++++++++++++++++++++++
site/hugo.yaml | 10 +++++--
3 files changed, 56 insertions(+), 4 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index f843b42b6..a5ce12247 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -126,8 +126,17 @@ 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
+## Code Contribution Guidelines
+To ensure smooth collaboration and to maintain a high-quality codebase, please
adhere to the following guidelines when make code contributions:
+
+* Follow the existing code style and conventions used.
+* Write clear, concise, and well-documented code. This includes providing
inline comments when necessary.
+* Keep your changes focused and granular. Separate unrelated changes into
multiple pull requests.
+* Write unit tests for your code changes, whenever applicable, and make sure
the existing tests pass successfully.
+* Make sure your code compiles without any errors or warnings.
+* Avoid introducing unnecessary dependencies. If you need to include a new
dependency, please justify it and discuss with the community first (using the
dev mailing list).
+* Be responsive and open to feedback during the code review process.
* 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.
diff --git a/site/content/community/community-guidelines.md
b/site/content/community/community-guidelines.md
new file mode 100644
index 000000000..50acb6d28
--- /dev/null
+++ b/site/content/community/community-guidelines.md
@@ -0,0 +1,39 @@
+---
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+linkTitle: Community Guidelines
+type: docs
+weight: 500
+---
+
+# Community Guidelines
+
+We value and appreciate the diverse contributions and ideas from the
community. To maintain a welcoming and inclusive environment, we kindly ask you
to adhere to the following guidelines:
+
+* Be respectful and considerate of other community members. Treat everyone
with respect and professionalism.
+* Refrain from engaging in offensive, discriminatory, or harassing behavior.
+* Be patient and understanding towards others, especially newcomers who may be
learning.
+* Stay constructive and provide helpful feedback.
+* Engage in meaningful and relevant discussions related to the project.
+* Avoid spamming, excessive self-promotion, or advertising unrelated content.
+* Use clear and consise language to facilitate effective communication.
+
+You can also take a look on the [Code of
Conduct](https://github.com/apache/polaris/blob/main/CODE_OF_CONDUCT.md), and
the ASF [Code of
Conduct](https://www.apache.org/foundation/policies/conduct.html).
+
+The Polaris community is built on the principles described in the [Apache
Way](https://www.apache.org/theapacheway/index.html).
diff --git a/site/hugo.yaml b/site/hugo.yaml
index 589cb37d0..8af27df8f 100644
--- a/site/hugo.yaml
+++ b/site/hugo.yaml
@@ -148,18 +148,22 @@ menu:
parent: "community"
url: "/community/contributing-guidelines"
weight: 60
+ - name: "Community Guidelines"
+ parent: "community"
+ url: "/community/community-guidelines"
+ weight : 70
- name: "Security Report"
parent: "community"
url: "/community/security-report"
- weight: 70
+ weight: 80
- name: "Release Guide"
parent: "community"
url: "/community/release-guide"
- weight: 70
+ weight: 90
- name: "Blogs"
parent: "community"
url: "/blog"
- weight: 80
+ weight: 100
- name: "GitHub"
url: "https://github.com/apache/polaris";
