Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .coderabbit.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
#
# 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.
#

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
inheritance: true
reviews:
path_instructions:
- path: "{**/*,**/.*,**/.*/**,.*/**/.*}"
instructions: |
Follow .editorconfig and docs/CONTRIBUTING.md for all reviewed files.
Ordinary code uses a 120-column margin, UTF-8 and LF. Markdown prose
may wrap at about 160 columns or keep complete paragraphs on one line.
Do not request 80- or 100-column wrapping, or apply the code margin to
Markdown prose. Preserve code-block formatting, links and tables.
Follow language-specific indentation and do not use Java star imports.
17 changes: 17 additions & 0 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,11 @@ The following is a contribution guide for HugeGraph:

<img width="884" alt="image" src="https://user-images.githubusercontent.com/9625821/159643158-8bf72c0a-93c3-4a58-8912-7b2ab20ced1d.png">

## Source formatting

Follow [.editorconfig](../.editorconfig): ordinary code uses a 120-column margin, UTF-8 and LF. Java uses four spaces and no star imports.
Markdown may wrap near 160 columns or keep complete paragraphs on one line. Keep links, tables and code blocks intact; do not force 80- or 100-column wrapping.

## 1. Preparation

**Recommended**: You can use [GitHub desktop](https://desktop.github.com/) to greatly simplify the PR process.
Expand Down Expand Up @@ -148,6 +153,18 @@ Please click on "Details" to find the problem if any check does not pass.

If there are checks not passed or changes requested, then continue to modify the code and push again.

### CI runs and automatic retries

PR test workflows keep only the newest run for each workflow and PR. Updating a PR
cancels its older queued or running checks; push, release and manual runs remain independent.
Reusable workflows inherit cancellation from their caller and do not add a competing group.

Automatic retries are limited to failed jobs within the existing retry budget. After the
retry delay, CI checks that the run is still failed and that the PR is open at the same
head commit, or that the pushed branch still points to that commit. Obsolete runs and
runs whose state cannot be verified are skipped. This policy applies to YAML workflows;
GitHub-managed Copilot and automatic dependency submission runs are configured separately.

## 6. Further changes after review

If we have not passed the review, don't be discouraged. Usually a commit needs to be reviewed several times before being accepted! Please follow the review comments and make further changes.
Expand Down
Loading