What is the format of the title of Issues and PRs?

[healchow]

What is the format of the title of Issues and PRs?

Issue 和 PR 的标题，应当遵循什么格式？

[healchow]

Title of Issues

In the InLong project, the title format of the Issue is suggested as follows:

[Module] The brief of your feature/improve/bug

For example:

[Manager] Add version control for the stream source

Title of Pull requests

In the InLong project, the title format of the PR is suggested as follows:

[INLONG-1234][Module] Your message

1. [INLONG-1234] represents the issue number associated with this commit.

2. [Module] indicates which module or part of Apache InLong this commit belongs to.

3. After a space, write your commit message, start with a capital letter, and cannot end with a number, space, or punctuation.

For example:

[INLONG-3293][Manager] Add version control for the stream source

InLong module

Currently, The module of InLong includes:

Agent | Audit | Dashboard | DataProxy | SDK | Sort | Sort-Flink | Sort-Standalone | TubeMQ | Manager | Website

Those modules are also supported:

InLong | K8s | Docker | CI | GitHub | Doc | POM

If your commit involves multiple modules, please use [InLong] as the module.

[shink]

BTW, I think the module named [InLong] with the same name as this project is redundant. If the issue or pull request involves multiple modules, their labels can be used to identify their modules.
And, I have checked out some other projects¹², they usually use [CI], [K8s]. But I think this is not the key. The purpose of the title is to indicate what this issue or pull request does. As long as the title can indicate what the issue or PR does, it is a good title.
It's just my idea.

Footnotes

1. https://github.com/apache/dolphinscheduler/issues?q=is%3Aissue+is%3Aopen+%5Bci%5D ↩

2. https://github.com/apache/flink/pulls?q=is%3Apr+%5Bk8s%5D+is%3Aclosed ↩

[healchow]

If users don't use the browser but view the Issues or PRs directly through the IDE, they can not see labels.

Okay, we add K8s, Docker, and CI into our module.

[shink]

Thank you. You're right. But I think an issue or pull request usually only involves one or two modules, up to three. So all modules can be completely added to the title. And I think that the module named [InLong] only indicate that this issue or PR belongs to the InLong project, but it cannot indicate which modules of InLong it involves.

[healchow]

How to deal with a situation like this #3634?

[shink]

This PR does involve many mudules, but even with [InLong], it doesn't make it clear which modules it involves, so I think it's redundant.
I think the key to title naming is whether it can indicate what the issue or PR does. As long as the title can indicate what the issue or PR does, it is a good title. Meantime, it should be as short as possible. So, I think the title naming should be more liberal. In this case, I think the title should be [INLONG-3622] Tidy up dependencies for all modules. The title message already shows that this PR involves all modules.
It's just my idea.