continuwuation/continuwuity
continuwuation/continuwuity
13
79
Fork 85
Code Issues 117 Pull requests 44 Releases 27 Packages 3 Activity Actions 9

style(commit): don't require subject capitalization #1391

Open
julian45 wants to merge 1 commit from julian45/continuwuity:julian/committed-cc-fix into main
pull from: julian45/continuwuity:julian/committed-cc-fix
merge into: continuwuation:main
Conversation 3 Commits 1 Files changed 1 +1
julian45 commented 2026-02-16 03:15:17 +00:00
Member
Copy link

This pull request aligns the implementation of the Conventional Commits spec in pre-commit hooks with the actual spec, namely regarding capitalizing the first character of the subject (aka description).

The committed hook defaults, at time of writing, to requiring the first letter of the subject to be capitalized. However, this is not in line with the actual CC spec:

  • paragraph #5 merely requires presence & defines purpose of subject
  • all examples on the CC spec page have the first letter of the subject in lowercase
  • paragraph #15 requires that implementers of the spec MUST NOT treat the various components of the commit message as case-sensitive (except when noting a BREAKING CHANGE, which must be uppercase)

Hence, this PR seeks to adjust the committed hook's configuration. Although an RFE exists upstream to require subject non-capitalization, it has not seen any activity in a long time (besides adding a label in September 2025, the last comment on it was in November 2024).

Pull request checklist:

  • This pull request targets the main branch, and the branch is named something other than
    main.
  • I have written an appropriate pull request title and my description is clear.
  • I understand I am responsible for the contents of this pull request.
  • I have followed the contributing guidelines:
<!-- In order to help reviewers know what your pull request does at a glance, you should ensure that 1. Your PR title is a short, single sentence describing what you changed 2. You have described in more detail what you have changed, why you have changed it, what the intended effect is, and why you think this will be beneficial to the project. If you have made any potentially strange/questionable design choices, but didn't feel they'd benefit from code comments, please don't mention them here - after opening your pull request, go to "files changed", and click on the "+" symbol in the line number gutter, and attach comments to the lines that you think would benefit from some clarification. --> This pull request aligns the implementation of the [Conventional Commits spec](https://www.conventionalcommits.org/en/v1.0.0/) in pre-commit hooks with the actual spec, namely regarding capitalizing the first character of the subject (aka description). The [committed](https://github.com/crate-ci/committed) hook defaults, at time of writing, to requiring the first letter of the subject to be capitalized. However, this is not in line with the actual CC spec: - paragraph #5 merely requires presence & defines purpose of subject - all examples on the CC spec page have the first letter of the subject in lowercase - paragraph #15 requires that implementers of the spec MUST NOT treat the various components of the commit message as case-sensitive (except when noting a BREAKING CHANGE, which must be uppercase) Hence, this PR seeks to adjust the committed hook's configuration. Although [an RFE exists upstream](https://github.com/crate-ci/committed/issues/408) to require subject *non*-capitalization, it has not seen any activity in a long time (besides adding a label in September 2025, the last comment on it was in November 2024). <!-- Example: This pull request allows us to warp through time and space ten times faster than before by double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more efficient. This resolves the common issue where we have to wait more than 10 milliseconds to engage, use, and disengage the warp drive when travelling between galaxies. --> <!-- Closes: #... --> <!-- Fixes: #... --> <!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request by superseding it. Replace `#...` with the issue/pr number, such as `#123`. --> **Pull request checklist:** <!-- You need to complete these before your PR can be considered. If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. --> - [x] This pull request targets the `main` branch, and the branch is named something other than `main`. - [x] I have written an appropriate pull request title and my description is clear. - [x] I understand I am responsible for the contents of this pull request. - I have followed the [contributing guidelines][c1]: - [x] My contribution follows the [code style][c2], if applicable. - [x] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [x] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [x] My commit messages follow the [commit message format][c1cm] and are descriptive. - [] I have written a [news fragment][n1] for this PR, if applicable<!--(can be done after hitting open!)-->. <!-- Notes on these requirements: - While not required, we encourage you to sign your commits with GPG or SSH to attest the authenticity of your changes. - While we allow LLM-assisted contributions, we do not appreciate contributions that are low quality, which is typical of machine-generated contributions that have not had a lot of love and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up the codebase with a +-100,000 diff. - In the case of code style violations, reviewers may leave review comments/change requests indicating what the ideal change would look like. For example, a reviewer may suggest you lower a log level, or use `match` instead of `if/else` etc. - In the case of code style violations, pre-commit check failures, minor things like typos/spelling errors, and in some cases commit format violations, reviewers may modify your branch directly, typically by making changes and adding a commit. Particularly in the latter case, a reviewer may rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword commit messages that don't satisfy the format. - Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be bypassed in exceptional circumstances. If your CI flakes, let us know in matrix:r/dev:continuwuity.org. - Pull requests have to be based on the latest `main` commit before being merged. If the main branch changes while you're making your changes, you should make sure you rebase on main before opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind. - We typically only do fast-forward merges, so your entire commit log will be included. Once in main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras! --> [c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md [c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx [c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks [c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally [c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages [n1]: https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments
julian45 force-pushed julian/committed-cc-fix from ababda1fd9
Some checks are pending
Documentation / Build and Deploy Documentation (pull_request) Waiting to run
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Waiting to run
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Waiting to run
Details
Update flake hashes / update-flake-hashes (pull_request) Successful in 45s
Details
to 0b73950fd3
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m14s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Details
2026-02-16 03:15:30 +00:00 Compare
julian45 force-pushed julian/committed-cc-fix from 0b73950fd3
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m14s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Details
to 651a7d75ce
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m43s
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 7m6s
Details
2026-02-16 18:06:00 +00:00 Compare
nex commented 2026-02-16 20:37:14 +00:00
Owner
Copy link

I'm not sure I'm fond of this change really. Enforcing first-letter capitalisation means commit messages look consistent throughout history, if we permit any casing it'll end up looking at bit wonky if you check back in history. Otherwise it's probably fine I guess

I'm not sure I'm fond of this change really. Enforcing first-letter capitalisation means commit messages look consistent throughout history, if we permit any casing it'll end up looking at bit wonky if you check back in history. Otherwise it's probably fine I guess
Jade commented 2026-02-16 20:38:11 +00:00
Owner
Copy link

Basically what nex said - we would have to enforce it in one direction or the other

Basically what nex said - we would have to enforce it in one direction or the other
julian45 commented 2026-02-16 22:28:45 +00:00
Author
Member
Copy link

Hmm... neither of the two most salient pre-commit hooks to this discussion distinctly enforce non-capitalization:

  • for committed, as noted when opening this PR, there's an RFE for it but it hasn't seen activity in ages
  • for the hook that @nex uses over in hammerhead, there does not seem to be enforcement in either direction, as shown in the screenshot below:
    image

I'd say that gives this discussion three possible future results:

  • switching over to the other hook, which seems agreeable enough to use in general but doesn't strictly enforce capitalization one way or the other at this time; or
  • abandoning this PR for the time being, unless and until committed makes available a way to enforce non-capitalization; or
  • seeing about getting commitlint's CC implementation working as a prek hook, since that implementation is cited as a reference in the committed RFE and supports specifying non-capitalization via the rule subject-case

A successful attempt of number 3 seems like the best case for this PR, with number 1 as a possible compromise and number 2 as not ideal (to me at least) since, per the motivation of this PR, it technically leaves in place a contradiction to CC spec and seems unlikely to be successful. Hence, I think I'll give number 3 a shot for now.

Hmm... neither of the two most salient pre-commit hooks to this discussion distinctly enforce *non*-capitalization: - for committed, as noted when opening this PR, there's an RFE for it but it hasn't seen activity in ages - for [the hook](https://github.com/compilerla/conventional-pre-commit) that @nex uses [over in hammerhead](https://codeberg.org/timedout/hammerhead/src/branch/dev/.pre-commit-config.yaml#L74), there does not seem to be enforcement in either direction, as shown in the screenshot below: ![image](/attachments/5a8b33d0-072f-499b-9751-1449cb1ca03c) I'd say that gives this discussion three possible future results: - switching over to the other hook, which seems agreeable enough to use in general but doesn't strictly enforce capitalization one way or the other at this time; or - abandoning this PR for the time being, unless and until committed makes available a way to enforce non-capitalization; *or* - seeing about getting commitlint's CC implementation working as a prek hook, since that implementation is cited as a reference in the committed RFE and [supports specifying non-capitalization via the rule `subject-case`](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional#subject-case) A successful attempt of number 3 seems like the best case for this PR, with number 1 as a possible compromise and number 2 as not ideal (to me at least) since, per the motivation of this PR, it technically leaves in place a contradiction to CC spec and seems unlikely to be successful. Hence, I think I'll give number 3 a shot for now.
image.png
158 KiB
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m43s
Required
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Successful in 7m6s
Required
Details
This pull request is blocked because it's outdated.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u julian/committed-cc-fix:julian45-julian/committed-cc-fix
git switch julian45-julian/committed-cc-fix
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
Blocked

This pull request or issue is currently blocked from being merged/closed

  
Bug

Something isn't working as intended

  
Cherry-picking

Commits picked from other conduit projects

  
Database

This requires or includes changes to the database

  
Dependencies

Something dependency related

  
Dependencies/Renovate

Automatic dependency upgrades by Renovate

  
Difficulty
Easy
Low difficulty to implement - touches few parts of the codebase, low complexity

  
Difficulty
Hard
High difficulty to implement - touches many parts of the codebase, high complexity

  
Difficulty
Medium
Medium difficulty to implement - touches more parts of the codebase, higher complexity

  
Documentation

Improvements or additions to documentation

  
Enhancement

New feature or request

  
Good first issue

Good for newcomers

  
Help wanted

Additional eyes and keyboards are required for this one

  
Inherited

Issues that have been inhereted from the project pre-fork

  
Matrix/Administration

Features pertaining to homeserver administration

  
Matrix/Appservices

Features pertaining to the appservice API

  
Matrix/Auth

Features pertaining to authentication

  
Matrix/Client

Features pertaining to client-to-server interactions

  
Matrix/Core

Issues relating to core matrix functionality, such as state resolution and PDU formats

  
Matrix/E2EE

   
Matrix/Federation

Features pertaining to server-to-server interactions

  
Matrix/Hydra

Issues related to room version 12 and related changes (temporary label)

  
Matrix/MSC

Features pertaining to unstable matrix features

  
Matrix/Media

Features pertaining to media interactions

  
Matrix/T&S

Changes or issues related to trust & safety tooling

  
Meta

Related to housekeeping, maintenance, or other repo-meta.

  
Meta/CI

Issues related to CI changes

  
Meta/Packaging

Packaging

  
Priority
Blocking
This issue is blocking the next release

  
Priority
High
This issue is very important

  
Priority
Low
This issue is of a rather low priority

  
Security

This item is related to general security

  
Status
Confirmed
This issue has enough information and is confirmed

  
Status
Duplicate
This issue or pull request already exists

  
Status
Invalid
This issue doesn't seem right

  
Status
Needs Investigation
This issue needs further investigation

  
Support

Questions or support requests

  
To-Merge

   
Wont fix

This will not be worked on

  
old/ci/cd

Ci/CD

Archived

  
old/rust

Pull requests that update Rust code

Archived

No labels
Blocked
Bug
Cherry-picking
Database
Dependencies
Dependencies/Renovate
Difficulty
Easy
Difficulty
Hard
Difficulty
Medium
Documentation
Enhancement
Good first issue
Help wanted
Inherited
Matrix/Administration
Matrix/Appservices
Matrix/Auth
Matrix/Client
Matrix/Core
Matrix/E2EE
Matrix/Federation
Matrix/Hydra
Matrix/MSC
Matrix/Media
Matrix/T&S
Meta
Meta/CI
Meta/Packaging
Priority
Blocking
Priority
High
Priority
Low
Security
Status
Confirmed
Status
Duplicate
Status
Invalid
Status
Needs Investigation
Support
To-Merge
Wont fix
old/ci/cd
old/rust
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1391
No description provided.