About project itself suggestion: pr merged commit should add github number

[Zeroto521]

To this one, it should be "Rename discussion.md to discussion.md.not_used (#501)".

Why add this?

Well, when we click "Rename discussion.md to discussion.md.not_used" text in github, we could see the difference.
But we more care about PR, it contains more.

You may say the following page has the github number (red marked one), but it's too tiny to find.

How to add?

Like the following one, I thought a pr title should be the commit, not the branch.

[JohnTheGr8]

Are you suggesting adding the PR number in every commit of the PR? This could be tricky when it comes to the first commits of the PR...

Or do you suggest using more helping commit messages when merging PRs? If that's the case, I fully agree...

The commit history of this repo is a bit messy right now, just open the commits page and you get:

4 out of the 5 top commits are merge commits that provide almost no information on first glance... Using more informative commit messages in the merge commits along with the PR number would be helpful here.

[jjw24]

Adding a pr number to each commit is an overkill, a better practice is to make commit messages more descriptive. To find the pr the commit is associated with, you can click on the commit and it will show you the pr number link.

Dont know there is anything we can do with those merge commits because the time it's merged is different to the time the commit is checked in, but the branch should describe what the pr is addressing.

[Zeroto521]

This issue's main aim is to patch PR number.

This could be tricky when it comes to the first commits of the PR...

Notice PR number is added by PR's author. It's added by who merges this PR into project's branch.
That says PR number should be added by us.

Like the following one. When this everything is ok, before merged, github default pr info is Merge pull request #30 from Zeroto521/python-plugin-template. But we should change to Let Flow-Launcher/Flow.Launcher.Plugin.PythonTemplate readme could show (#30), PR title + PR number.

This image should be correct. PR is Flow-Launcher/docs#30.

[Zeroto521]

Or do you suggest using more helping commit messages when merging PRs? If that's the case, I fully agree...

Yes, I also have this means.
Now we should do "PR title + PR number" first.

Later we could specific "PR title" should be what.

Such as using the standard acronyms to start the commit message.

• EHN: enhancement or new feature
• DOC: documentation
• STY: style fix
• DEP: deprecate something, or remove a deprecated object
• PLUGIN: about plugin development
• CI: CI/CD
• BLD: about build workflow
• TST: addition or modification of tests
• REL: related to releasing
• MAINT: maintenance commit (refactoring, typos, etc.)
• REV: revert an earlier commit
• ...

[github-actions]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.

[Zeroto521]

An easy way could use 'squash and merge' action in github.

[jjw24]

We can use squash, although because we require pr for changes, in general it's much easier just to look at the associated pr because that will give more context on the change and the driver behind it.

[Zeroto521]

And we could set 'squash and merge' as the only option via the project setting page.