This is an automated email from the ASF dual-hosted git repository.
yuanzhou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-gluten.git
The following commit(s) were added to refs/heads/main by this push:
new 9c27e8f839 [INFRA] Update pull request template and remove title check
(#10376)
9c27e8f839 is described below
commit 9c27e8f839a8d759acefb2324f15d8ff8579e1fb
Author: PHILO-HE <[email protected]>
AuthorDate: Wed Aug 13 16:47:52 2025 +0800
[INFRA] Update pull request template and remove title check (#10376)
Revise the template to provide additional guidelines and conceal them using
comments.
Remove the PR title check, as some PRs, such as those fixing typos or
updating documents, do not necessitate creating a GitHub issue. However, the
provided guidelines still encourage developers to create a GitHub issue when
appropriate.
---
.github/PULL_REQUEST_TEMPLATE | 30 ++++++++++++-----
.github/workflows/dev_cron.yml | 14 --------
.github/workflows/dev_cron/title_check.js | 53 -------------------------------
.github/workflows/dev_cron/title_check.md | 33 -------------------
4 files changed, 22 insertions(+), 108 deletions(-)
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
index 614e2fdbb6..1076f58ecb 100644
--- a/.github/PULL_REQUEST_TEMPLATE
+++ b/.github/PULL_REQUEST_TEMPLATE
@@ -1,13 +1,27 @@
-## What changes were proposed in this pull request?
+<!--
+Thank you for submitting a pull request! Here are some tips:
-(Please fill in changes proposed in this fix)
+1. For first-time contributors, please read our contributing guide:
+ https://github.com/apache/incubator-gluten/blob/main/CONTRIBUTING.md
+2. If necessary, create a GitHub issue for discussion beforehand to avoid
duplicate work.
+3. If the PR is specific to a single backend, include [VL] or [CH] in the PR
title to indicate the
+ Velox or ClickHouse backend, respectively.
+4. If the PR is not ready for review, please mark it as a draft.
+-->
-(Fixes: \#ISSUE-ID)
+## What changes are proposed in this pull request?
-## How was this patch tested?
-
-(Please explain how this patch was tested. E.g. unit tests, integration tests,
manual tests)
+<!--
+Provide a clear and concise description of the changes introduced in this PR.
+Ensure the PR description aligns with the code changes, especially after
updates.
+If applicable, include "Fixes #<GitHub_Issue_ID>" to automatically close the
corresponding issue
+when the PR is merged.
+-->
+## How was this patch tested?
-(If this patch involves UI changes, please attach a screenshot; otherwise,
remove this)
-
+<!--
+Describe how the changes were tested, if applicable.
+Include new tests to validate the functionality, if necessary.
+For UI-related changes, attach screenshots to demonstrate the updates.
+-->
diff --git a/.github/workflows/dev_cron.yml b/.github/workflows/dev_cron.yml
index 193549cc07..834ab8d579 100644
--- a/.github/workflows/dev_cron.yml
+++ b/.github/workflows/dev_cron.yml
@@ -30,7 +30,6 @@ jobs:
permissions: write-all
steps:
- uses: actions/checkout@v4
-
- name: Comment Issues link
if: |
github.event_name == 'pull_request_target' &&
@@ -42,16 +41,3 @@ jobs:
script: |
const script =
require(`${process.env.GITHUB_WORKSPACE}/.github/workflows/dev_cron/issues_link.js`);
script({github, context});
-
- - name: Check title
- if: |
- github.event_name == 'pull_request_target' &&
- (github.event.action == 'opened' ||
- github.event.action == 'edited')
- uses: actions/github-script@v7
- with:
- github-token: ${{ secrets.GITHUB_TOKEN }}
- script: |
- const script =
require(`${process.env.GITHUB_WORKSPACE}/.github/workflows/dev_cron/title_check.js`);
- script({github, context});
-
diff --git a/.github/workflows/dev_cron/title_check.js
b/.github/workflows/dev_cron/title_check.js
deleted file mode 100644
index 1e6df340f2..0000000000
--- a/.github/workflows/dev_cron/title_check.js
+++ /dev/null
@@ -1,53 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-const fs = require("fs");
-
-function haveISSUESID(title) {
- if (!title) {
- return false;
- }
- return /^\[GLUTEN-\d+\]/.test(title);
-}
-
-async function commentOpenISSUESIssue(github, context, pullRequestNumber) {
- const {data: comments} = await github.rest.issues.listComments({
- owner: context.repo.owner,
- repo: context.repo.repo,
- issue_number: pullRequestNumber,
- per_page: 1
- });
- if (comments.length > 0) {
- return;
- }
- const commentPath = ".github/workflows/dev_cron/title_check.md";
- const comment = fs.readFileSync(commentPath).toString();
- await github.rest.issues.createComment({
- owner: context.repo.owner,
- repo: context.repo.repo,
- issue_number: pullRequestNumber,
- body: comment
- });
-}
-
-module.exports = async ({github, context}) => {
- const pullRequestNumber = context.payload.number;
- const title = context.payload.pull_request.title;
- if (!haveISSUESID(title)) {
- await commentOpenISSUESIssue(github, context, pullRequestNumber);
- }
-};
diff --git a/.github/workflows/dev_cron/title_check.md
b/.github/workflows/dev_cron/title_check.md
deleted file mode 100644
index 83d4937ed2..0000000000
--- a/.github/workflows/dev_cron/title_check.md
+++ /dev/null
@@ -1,33 +0,0 @@
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICEGJ-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-Thanks for opening a pull request!
-
-Could you open an issue for this pull request on Github Issues?
-
-https://github.com/apache/incubator-gluten/issues
-
-Then could you also rename ***commit message*** and ***pull request title***
in the following format?
-
- [GLUTEN-${ISSUES_ID}][COMPONENT]feat/fix: ${detailed message}
-
-See also:
-
- * [Other pull requests](https://github.com/apache/incubator-gluten/pulls/)
-
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
