Skip to content

Commit f9a2165

Browse files
authored
Add content to contributing guidelines. (apache#2536)
Add community guidelines.
1 parent 149c19e commit f9a2165

File tree

3 files changed

+56
-4
lines changed

3 files changed

+56
-4
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,8 +126,17 @@ The Apache Polaris build currently requires Java 21 or later. There are a few to
126126
* [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.
127127
* [jenv](https://www.jenv.be/) If on a Mac you can use jenv to set the appropriate SDK.
128128

129-
## Good Practices
129+
## Code Contribution Guidelines
130130

131+
To ensure smooth collaboration and to maintain a high-quality codebase, please adhere to the following guidelines when make code contributions:
132+
133+
* Follow the existing code style and conventions used.
134+
* Write clear, concise, and well-documented code. This includes providing inline comments when necessary.
135+
* Keep your changes focused and granular. Separate unrelated changes into multiple pull requests.
136+
* Write unit tests for your code changes, whenever applicable, and make sure the existing tests pass successfully.
137+
* Make sure your code compiles without any errors or warnings.
138+
* 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).
139+
* Be responsive and open to feedback during the code review process.
131140
* Change of public interface (or more generally speaking Polaris extension point) should be discussed and approved on the dev mailing list.
132141
The discussion on the dev mailing list should happen before having a "ready-for-review" Pull Request.
133142
* `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.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
#
3+
# Licensed to the Apache Software Foundation (ASF) under one
4+
# or more contributor license agreements. See the NOTICE file
5+
# distributed with this work for additional information
6+
# regarding copyright ownership. The ASF licenses this file
7+
# to you under the Apache License, Version 2.0 (the
8+
# "License"); you may not use this file except in compliance
9+
# with the License. You may obtain a copy of the License at
10+
#
11+
# http://www.apache.org/licenses/LICENSE-2.0
12+
#
13+
# Unless required by applicable law or agreed to in writing,
14+
# software distributed under the License is distributed on an
15+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16+
# KIND, either express or implied. See the License for the
17+
# specific language governing permissions and limitations
18+
# under the License.
19+
#
20+
linkTitle: Community Guidelines
21+
type: docs
22+
weight: 500
23+
---
24+
25+
# Community Guidelines
26+
27+
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:
28+
29+
* Be respectful and considerate of other community members. Treat everyone with respect and professionalism.
30+
* Refrain from engaging in offensive, discriminatory, or harassing behavior.
31+
* Be patient and understanding towards others, especially newcomers who may be learning.
32+
* Stay constructive and provide helpful feedback.
33+
* Engage in meaningful and relevant discussions related to the project.
34+
* Avoid spamming, excessive self-promotion, or advertising unrelated content.
35+
* Use clear and consise language to facilitate effective communication.
36+
37+
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).
38+
39+
The Polaris community is built on the principles described in the [Apache Way](https://www.apache.org/theapacheway/index.html).

site/hugo.yaml

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -148,18 +148,22 @@ menu:
148148
parent: "community"
149149
url: "/community/contributing-guidelines"
150150
weight: 60
151+
- name: "Community Guidelines"
152+
parent: "community"
153+
url: "/community/community-guidelines"
154+
weight : 70
151155
- name: "Security Report"
152156
parent: "community"
153157
url: "/community/security-report"
154-
weight: 70
158+
weight: 80
155159
- name: "Release Guide"
156160
parent: "community"
157161
url: "/community/release-guide"
158-
weight: 70
162+
weight: 90
159163
- name: "Blogs"
160164
parent: "community"
161165
url: "/blog"
162-
weight: 80
166+
weight: 100
163167

164168
- name: "GitHub"
165169
url: "https://github.com/apache/polaris"

0 commit comments

Comments
 (0)