From 72678448fab939733b02fceea0fc7afa570fec24 Mon Sep 17 00:00:00 2001 From: Zhiguo Wu Date: Mon, 8 Dec 2025 16:03:38 +0800 Subject: [PATCH 1/2] Change pr title checker --- .github/actions/pr-title-checker | 1 - .github/pr-title-checker-config.json | 14 -------------- .github/workflows/pr.yml | 14 ++++---------- .gitmodules | 3 --- 4 files changed, 4 insertions(+), 28 deletions(-) delete mode 160000 .github/actions/pr-title-checker delete mode 100644 .github/pr-title-checker-config.json diff --git a/.github/actions/pr-title-checker b/.github/actions/pr-title-checker deleted file mode 160000 index 1d8cd483a..000000000 --- a/.github/actions/pr-title-checker +++ /dev/null @@ -1 +0,0 @@ -Subproject commit 1d8cd483a2b73118406a187f54dca8a9415f1375 diff --git a/.github/pr-title-checker-config.json b/.github/pr-title-checker-config.json deleted file mode 100644 index 4d3d2e48f..000000000 --- a/.github/pr-title-checker-config.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "LABEL": { - "name": "title needs formatting", - "color": "EEEEEE" - }, - "CHECKS": { - "regexp": "^BIGTOP-\\d{1,9}: .*" - }, - "MESSAGES": { - "success": "PR title is valid", - "failure": "PR title is invalid", - "notice": "PR Title needs to pass regex '^BIGTOP-\\d{1,9}: .*'" - } -} \ No newline at end of file diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 7f03f4d91..75263b585 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -7,15 +7,9 @@ jobs: check-pr-title: name: "Check PR Title" runs-on: ubuntu-latest + permissions: + pull-requests: read steps: - - name: "Checkout ${{ github.ref }} ( ${{ github.sha }} )" - uses: actions/checkout@v4 - with: - persist-credentials: false - submodules: recursive - - name: "Check PR Title" - uses: ./.github/actions/pr-title-checker - with: + - uses: amannn/action-semantic-pull-request@v6 + env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - pass_on_octokit_error: false - configuration_path: .github/pr-title-checker-config.json diff --git a/.gitmodules b/.gitmodules index 66d503fbb..e69de29bb 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,3 +0,0 @@ -[submodule ".github/actions/pr-title-checker"] - path = .github/actions/pr-title-checker - url = https://github.com/thehanimo/pr-title-checker.git From 18585dd5d9739b54a83f8e60f7e50a807c1b2c62 Mon Sep 17 00:00:00 2001 From: Zhiguo Wu Date: Fri, 12 Dec 2025 15:22:21 +0800 Subject: [PATCH 2/2] update doc --- docs/en/contribution.md | 21 ++++++++------------- docs/zh/contribution.md | 25 +++++++++---------------- 2 files changed, 17 insertions(+), 29 deletions(-) diff --git a/docs/en/contribution.md b/docs/en/contribution.md index 1b626b09f..565d0b712 100644 --- a/docs/en/contribution.md +++ b/docs/en/contribution.md @@ -19,7 +19,7 @@ ## Setup ### Get the Code -First, you need to pull the Bigtop Manager source code from Github using the following command: +First, you need to pull the Bigtop Manager source code from GitHub using the following command: `git clone git@github.com:apache/bigtop-manager.git` @@ -107,16 +107,11 @@ Vue: ./mvnw -pl bigtop-manager-ui test ``` -## Create an Issue -1. First, go to the [Bigtop](https://issues.apache.org/jira/projects/BIGTOP) project in Apache Jira. -2. Create an Issue. -3. Ensure that the Summary of the Issue is described in English. If possible, write the details in the Description, which also needs to be in English. -4. If you are submitting an issue for Bigtop Manager, click the Components option, select bigtop-manager, and also select the corresponding version for the Fix Version. Bigtop Manager starts with bm-, for example, bm-1.0.0 means this issue will be fixed in Bigtop Manager 1.0.0. The Affects Version is optional, and the rules are the same as above. - ## Submit Code -1. Get the Issue number. You can get the number from the Jira page or the URL. For example, if the current URL is: [https://issues.apache.org/jira/browse/BIGTOP-4162](https://issues.apache.org/jira/browse/BIGTOP-4162), then the number is BIGTOP-4162. -2. Create a local branch. It is recommended that one Issue corresponds to one branch, for example, `git checkout -b bigtop-4162`. -3. Submit your code to this branch and push the branch to your forked repository on Github. -4. Create a Pull Request. The naming rule for the Title is `ISSUE number: Description`, for example, `BIGTOP-4162: Add health check for components`. If the PR is complex, it is recommended to write a Description for both the Issue and the PR to explain the specific purpose. -5. Ensure that all Github CIs pass. If one fails, the PR will not be reviewed. -6. After the CIs pass normally, wait for the Maintainer to review your PR. If there are comments, please handle them in time. After the review passes, it can be merged. \ No newline at end of file +1. Fork the project on GitHub. +2. Clone your Forked repository locally, e.g., `git clone git@github.com:your-username/bigtop-manager.git`. +3. Create a local branch, e.g., `git checkout -b your-branch-name`. +4. Commit your code to that branch and push the branch to your Forked repository on GitHub. +5. Create a Pull Request, ensuring that the Title follows the [Conventional Commits Specification](https://www.conventionalcommits.org/). +6. Ensure that all GitHub CI checks pass; if any fail, the PR will not be reviewed. +7. After CI passes, wait for a Maintainer to review your PR. If there are comments, address them promptly. Once the review is approved, it can be merged. diff --git a/docs/zh/contribution.md b/docs/zh/contribution.md index 248edefd9..dcc40e206 100644 --- a/docs/zh/contribution.md +++ b/docs/zh/contribution.md @@ -16,7 +16,7 @@ ## 设置 ### 获取代码 -首先，您需要通过以下命令从 Github 中拉取 Bigtop Manager 源码: +首先，您需要通过以下命令从 GitHub 中拉取 Bigtop Manager 源码: `git clone git@github.com:apache/bigtop-manager.git` @@ -103,24 +103,17 @@ Vue: ./mvnw -pl bigtop-manager-ui test ``` -## 创建 Issue -1、首先进入 Apache Jira 中的 [Bigtop](https://issues.apache.org/jira/projects/BIGTOP) 项目 - -2、创建 Issue - -3、确保 Issue 的 Summary 是英文描述，如果可以的话请将细节写到 Description 下，也需要使用英文 - -4、如果是给 Bigtop Manager 提交项目，点击 Components 选项，选中 bigtop-manager，并且 Fix Version 也需要选择对应的版本，Bigtop Manager 以 bm- 开头，如 bm-1.0.0 代表这个 issue 将在 Bigtop Manager 1.0.0 版本修复。Affects Version 可选，规则同上 - ## 提交代码 -1、获取 Issue 编号，编号可从 Jira 页面或者 URL 中获取，如当前的 URL 为: [https://issues.apache.org/jira/browse/BIGTOP-4162](https://issues.apache.org/jira/browse/BIGTOP-4162)，则编号为 BIGTOP-4162 +1、在 GitHub 上 Fork 该项目 + +2、在本地克隆你 Fork 的仓库，如 `git clone git@github.com:your-username/bigtop-manager.git` -2、创建本地分支，建议一个 Issue 对应一个分支，如 `git checkout -b bigtop-4162` +3、创建本地分支，如 `git checkout -b your-branch-name` -3、提交代码至该分支中，并且将分支推到你的 Github 上的 Fork 的仓库中 +4、提交代码至该分支中，并且将分支推到你的 GitHub 上的 Fork 的仓库中 -4、创建 Pull Request，其中 Title 的命名规则为 `ISSUE编号: 描述`，如 `BIGTOP-4162: Add health check for components`，若 PR 较复杂，建议 Issue 和 PR 都编写 Description 来解释具体用途 +5、创建 Pull Request，其中 Title 的命名规则需遵守 [Conventional Commits Specification](https://www.conventionalcommits.org/) 规范 -5、确保 Github CI 均通过，若有一个失败则 PR 将不会被 Review +6、确保 GitHub CI 均通过，若有一个失败则 PR 将不会被 Review -6、CI 正常后等待 Maintainer Review 你的 PR，若有 Comment 请及时处理，Review 通过后即可被合并 \ No newline at end of file +7、CI 正常后等待 Maintainer Review 你的 PR，若有 Comment 请及时处理，Review 通过后即可被合并 \ No newline at end of file