Skip to content

Conversation

@xezon
Copy link

@xezon xezon commented Jul 25, 2025

Merge with Rebase

This change suggests to change commit title tags from our current custom ones to the conventional (extended) commit tags as highlighted by @aliendroid1.

The [GEN][ZH] tags are sort of obsolete anyway because we always replicate the changes to Generals in the same commit anyway. Originally it was intended to not lose oversight over which commits need replicating to Generals.

I also renamed @compile to @build in code comments so that it is consistent with the conventional commit type name.

@xezon xezon added Documentation Is documentation or complementary resource Minor Severity: Minor < Major < Critical < Blocker labels Jul 25, 2025
@xezon xezon force-pushed the xezon/change-contributing branch 2 times, most recently from 5e48f74 to a8e860e Compare July 25, 2025 18:30
@xezon xezon changed the title docs(contributing): introduce conventional commits to CONTRIBUTING.md docs: introduce conventional commits to CONTRIBUTING.md Jul 25, 2025
@Skyaero42
Copy link

CI should be changed too, to verify correct use of conventional commits

@xezon xezon force-pushed the xezon/change-contributing branch from a8e860e to 7c087cb Compare July 25, 2025 18:43
@xezon
Copy link
Author

xezon commented Jul 25, 2025

CI should be changed too, to verify correct use of conventional commits

Yes. I do not know how to do that. It requires changes in validate-pull-request.yml

@xezon
Copy link
Author

xezon commented Jul 25, 2025

Regarding the commit tags, how about we begin them with uppercase? All lower case looks strange to me.

@xezon
Copy link
Author

xezon commented Jul 26, 2025

I think the lower case sentencing looks strange. Every other title sentence we begin with upper. Every English sentence in books and articles begin with upper case letter. I have no clue why programmers suddently want to begin sentences with lower case.

I will be changing this. The title tags themselves can remain lower case, as we have them elsewhere in texts as well.

@xezon xezon changed the title docs: introduce conventional commits to CONTRIBUTING.md docs: Introduce conventional commits to CONTRIBUTING.md Jul 26, 2025
@xezon xezon force-pushed the xezon/change-contributing branch from 7c087cb to 6611637 Compare July 26, 2025 08:21
@barefootlogician
Copy link
Collaborator

I think the lower case sentencing looks strange. Every other title sentence we begin with upper. Every English sentence in books and articles begin with upper case letter. I have no clue why programmers suddently want to begin sentences with lower case.

I will be changing this. The title tags themselves can remain lower case, as we have them elsewhere in texts as well.

Personally I prefer lowercase just because that way its consistent with other repos that use conventional commits however this repo has enforced uppercase for commit headings so far so uppercase is a reasonable choice too as it maintains consistency with past commits.

I do find it odd too though that the convention is lowercase. I think the reasoning was to make it similar to git's messages, same as why imperative mode is preffered. Though imperative mood makes more sense to me because it also has the benefit of using less characters.

@barefootlogician
Copy link
Collaborator

CI should be changed too, to verify correct use of conventional commits

Yes. I do not know how to do that. It requires changes in validate-pull-request.yml

There are a few workflow options in github marketplace that we could consider using

@xezon
Copy link
Author

xezon commented Jul 29, 2025

@tintinhamans Can you help with the validate-pull-request.yml ?

Copy link

@Mauller Mauller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good to me

@xezon xezon force-pushed the xezon/change-contributing branch from 6611637 to e9adc2d Compare August 5, 2025 17:16
@xezon
Copy link
Author

xezon commented Aug 5, 2025

Rebased.

@xezon xezon merged commit a410605 into TheSuperHackers:main Aug 5, 2025
17 checks passed
@xezon xezon deleted the xezon/change-contributing branch August 5, 2025 17:50
fbraz3 pushed a commit to fbraz3/GeneralsX that referenced this pull request Nov 10, 2025
fbraz3 pushed a commit to fbraz3/GeneralsX that referenced this pull request Nov 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Is documentation or complementary resource Minor Severity: Minor < Major < Critical < Blocker

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants