[
https://issues.apache.org/jira/browse/CALCITE-7426?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=18062736#comment-18062736
]
Zhen Chen commented on CALCITE-7426:
------------------------------------
[~julianhyde] Thank you very much for your reply. I have modified the PR
template according to your suggestions. Secondly, as you said, we do indeed
need a Jira specification, and this requirement may be more urgent. I might try
to write one later, but I have never created a nice Jira example before, and
I'm worried that I might not have considered everything thoroughly. Once we
have a Jira specification, we can add this link to the PR template to help new
developers.
> 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 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.
> -->{code}
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
