You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@calcite.apache.org by zh...@apache.org on 2026/03/10 01:09:34 UTC

(calcite) branch main updated: [CALCITE-7426] Add a PR submission template to Calcite

This is an automated email from the ASF dual-hosted git repository.

zhenchen pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/calcite.git


The following commit(s) were added to refs/heads/main by this push:
     new 8a873607a9 [CALCITE-7426] Add a PR submission template to Calcite
8a873607a9 is described below

commit 8a873607a9eb7b9f56b504beb071c131f3721a96
Author: Zhen Chen <cz...@163.com>
AuthorDate: Fri Mar 6 15:07:04 2026 +0800

    [CALCITE-7426] Add a PR submission template to Calcite
---
 .github/pull_request_template.md | 43 ++++++++++++++++++++++++++++++++++++++++
 .ratignore                       |  2 +-
 2 files changed, 44 insertions(+), 1 deletion(-)

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 0000000000..842d8fbd69
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,43 @@
+<!--
+Thanks for sending a pull request! Here are some critical tips for you:
+
+1. READ THE GUIDE FIRST: https://calcite.apache.org/develop/#contributing
+   *For significant contributions, please discuss on the dev mailing list or Jira BEFORE coding.*
+
+2. JIRA IS USUALLY MANDATORY: Ensure you have created an issue on the Calcite Jira:
+   https://issues.apache.org/jira/projects/CALCITE/issues
+   *Check existing issues first to avoid duplicates.*
+   *Note: A Jira is NOT required for typos and cosmetic changes (i.e., changes that are neither bugs nor features).*
+
+3. TIMING: Strongly recommended to create the Jira BEFORE you start writing code (e.g., a day or so before posting a PR).
+   This gives others a chance to weigh in on your specification.
+
+4. CRITICAL CONSISTENCY RULE
+   The following three items MUST match exactly in wording and meaning:
+   (A) The Jira Issue Title
+   (B) This Pull Request Title
+   (C) Your Git Commit Message
+
+   Format: [CALCITE-XXXX] <Description>
+   Example: [CALCITE-0000] Add IF NOT EXISTS clause to CREATE TABLE
+
+   Guidelines for a good Title:
+   - Illustrate using SQL keywords (in ALL-CAPS) rather than Java method names.
+   - Focus on the specification and user experience, not the implementation.
+   - Make it clear whether it is a bug or a feature.
+   - Use words like "should" to indicate desired behavior vs. current behavior (e.g., "Validator should not close model file").
+
+5. REPRODUCTION: If fixing a bug, please provide a concise SQL example or test case to reproduce the issue for a faster review.
+
+6. TESTING: Ensure `./gradlew build` passes and appropriate tests are added/updated.
+-->
+
+## Jira Link
+
+[CALCITE-XXXX](https://issues.apache.org/jira/browse/CALCITE-XXXX)
+
+## Changes Proposed
+<!--
+Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
+If possible, please consider writing useful notes for better and faster reviews in your PR.
+-->
diff --git a/.ratignore b/.ratignore
index 65bd8f2cec..50e978b59a 100644
--- a/.ratignore
+++ b/.ratignore
@@ -2,7 +2,7 @@
 **/.editorconfig
 **/.gitignore
 **/.gitattributes
-.github/workflows
+.github/**
 .ratignore
 **/META-INF/services/java.sql.Driver
 **/src/test/resources/**/*.csv