[jira] [Commented] (IGNITE-19883) Add a review checklist to a PR in Apache Ignite 3 repository

["Vyacheslav Koptilin (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/IGNITE-19883?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17739564#comment-17739564 ] 

Vyacheslav Koptilin commented on IGNITE-19883:
----------------------------------------------

I think it would be nice to expand the section related to formal criteria in a way that is done for Apache Ignite 2:

{noformat}
**Formal criteria:** commit message, codestyle checks, TC status, mandatory documentation.
 - There is a single JIRA ticket related to the pull request.
 - The web-link to the pull request is attached to the JIRA ticket.
 - The JIRA ticket has the Patch Available state.
 - The description of the JIRA ticket explains WHAT and WHY was made and HOW.
 - The pull request title is treated as the final commit message. The following pattern must be used: IGNITE-XXXX Change summary where XXXX - number of JIRA issue.
{noformat}
 
This list will be useful for newcomers at least (what steps are mandatory and should be done before a patch/pull-request can be moved to the `patch available` state).

> Add a review checklist to a PR in Apache Ignite 3 repository
> ------------------------------------------------------------
>
>                 Key: IGNITE-19883
>                 URL: https://issues.apache.org/jira/browse/IGNITE-19883
>             Project: Ignite
>          Issue Type: Task
>            Reporter: Sergey Chugunov
>            Assignee: Sergey Chugunov
>            Priority: Major
>              Labels: ignite-3
>             Fix For: 3.0.0-beta2
>
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> We need to add a checklist of bullets to verify PR against right to the PRs pages in GitHub, like a list already implemented for PRs in AI2 repo:
> {noformat}
> 1. There is a single JIRA ticket related to the pull request.
> 2. The web-link to the pull request is attached to the JIRA ticket.
> 3. The JIRA ticket has the Patch Available state.
> 4. The pull request body describes changes that have been made. The description explains WHAT and WHY was made instead of HOW.
> 5. The pull request title is treated as the final commit message. The following pattern must be used: IGNITE-XXXX Change summary where XXXX - number of JIRA issue.
> 6. A reviewer has been mentioned through the JIRA comments (see the Maintainers list)
> 7. The pull request has been checked by the Teamcity Bot and the green visa attached to the JIRA ticket (see TC.Bot: Check PR)
> {noformat}
> Though in AI2 checklist if focused mostly on formal stuff, and we want to implement the list more dedicated to code quality and easy-to-review reqs.



--
This message was sent by Atlassian Jira
(v8.20.10#820010)