[GitHub] [incubator-uniffle] advancedxy opened a new issue, #551: [Improvement][CodingStyle] add autolink to issues in PR title and commit msg

[via GitHub]

advancedxy opened a new issue, #551:
URL: https://github.com/apache/incubator-uniffle/issues/551

   ### Code of Conduct
   
   - [X] I agree to follow this project's [Code of 
Conduct](https://www.apache.org/foundation/policies/conduct)
   
   
   ### Search before asking
   
   - [X] I have searched in the 
[issues](https://github.com/apache/incubator-uniffle/issues?q=is%3Aissue) and 
found no similar issues.
   
   
   ### What would you like to be improved?
   
   It's common and considered best practice to be able to click links to 
corresponding issues/PRs/tickets in the commit msg. To achieve this features, 
Github's autolinked references and links[^1] are used. 
   
   For example, Spark uses this feature to autolink Jiras. 
   <img width="1251" alt="image" 
src="https://user-images.githubusercontent.com/807537/216869357-205d4cfb-7a37-47a4-beba-fef632399e57.png";>
   
   Since Uniffle are using Github Issues to track issues/request/improvements, 
etc. The issue is effective the same as the Jira ticket.
   
   I'd like to propose an suggestion to improve the code context experience: 
add autolink to issues in PR title and commit msg.
   
   [^1]: 
https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls
   
   ### How should we improve?
   
   1. Let's decide which form to include autolinks:
      - [#xxx], the simple form, 
https://github.com/apache/incubator-uniffle/commit/cf9afab471a9595d8298ebd65c4d25c080ad4bbf
        <img width="956" alt="image" 
src="https://user-images.githubusercontent.com/807537/216869878-3023c60d-b64c-46eb-a631-47c8dd6eb915.png";>
 
      - [ISSUE #xxx] prefix with issue
   2. Enforce the pr title check.  Every PR should have an issue linked.
       However this may not applied to every case. There might be some 
exception rule to skip this check.
   
   
   
   ### Are you willing to submit PR?
   
   - [X] Yes I am willing to submit a PR!


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: dev-unsubscr...@uniffle.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org