[
https://issues.apache.org/jira/browse/CALCITE-7426?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18062557#comment-18062557
]
Julian Hyde commented on CALCITE-7426:
--------------------------------------
Thanks for taking the initiative to improve our process. A few comments.
* Though it was originally all-caps, Atlassian not recommends "Jira" not "JIRA"
* A Jira is not required for typos and cosmetic changes (i.e. changes that are
neither bugs nor features)
* Strongly recommended that not only do you create a Jira but you do it before
you start writing code, i.e. a day or so before you post a PR. This gives
others chance to weigh in on your specification.
* I guess we need guidelines elsewhere for what makes a good Jira title. Your
example shows the important points: illustrate using SQL keywords rather than
Java method names if possible (focusing on the specification, and user
experience of the bug, rather than the implementation); SQL keywords in
all-caps; make it clear from the text whether it is a bug or feature; use words
like "should" to indicate that the behavior described is desired behavior but
not current behavior.
* The body of the PR will usually just link to the Jira case and replicate its
first couple of paragraphs. The first paragraph of the Jira case should
describe the problem, or the desired new feature, from the perspective of the
user. Use as little jargon as possible. Do not refer to code (class names,
method names, "The variable at line 345 needs to be initialized", etc.) One or
two examples are really useful, even if you are linking to an external
specification (e.g. the Spark documentation of a particular SQL function).
Reading the last couple of comments, and since we are asking them to log a Jira
first, use its summary and opening paragraphs, I realize that we need a
description of how to log a good Jira case.
> Add a PR submission template to Calcite
> ---------------------------------------
>
> Key: CALCITE-7426
> URL: https://issues.apache.org/jira/browse/CALCITE-7426
> Project: Calcite
> Issue Type: Wish
> Reporter: Zhen Chen
> Priority: Minor
>
> I've noticed that many newcomers to Calcite are unfamiliar with the
> contribution process, often requiring experienced contributors to reply with
> a link to the contribution instructions in the PR. Could we provide a PR
> submission template, similar to those used in Hive or other projects, with
> accompanying instructions to help contributors quickly understand how to
> contribute to Calcite?
> I've created a simple template, but I'm not sure if it meets your needs.
> Since the Calcite project has never had a template, I've only provided a very
> basic one to avoid creating too much of a burden.
> {code:java}
> <!--
> 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 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.*
> 3. 🚨 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
> 4. REPRODUCTION: If fixing a bug, please provide a concise SQL example or
> test case to reproduce the issue for a faster review.
> 5. TESTING: Ensure `./gradlew build` passes and appropriate tests are
> added/updated.
> -->
> ## JIRA Link
> [CALCITE-](https://issues.apache.org/jira/browse/CALCITE-)
> ## 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.
> -->
> {code}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
