Re: Proposal to have a script to check MR for common mistakes
Akseli Lahtinen <[email protected]>
| Newsgroups | gmane.comp.kde.devel.general |
|---|---|
| Message-ID | <12947059.O9o76ZdvQC@desktop> |
On Tuesday 11 August 2026 18:45:10 Eastern European Summer Time Méven wrote: > Hi everyone, > > I'd like to add a script to our ci-utilities to allow failure builds based > on regular mistakes that regular contributors or newcomers can make. > > Like: > - putting links to invent.kde.org in commits > - having \since but the incorrect version > - missing \since on new API > - having links to bugs, instead of using our BUG:/CCBUG: > > I have implemented them: > https://invent.kde.org/sysadmin/ci-utilities/-/merge_requests/700 > > And I am thinking about another one: > - prevent commit message prefix with "fix:" or "feature" > > As a dolphin maintainer and kio one, I really would enjoy those as they > will reduce the number of times I have to repeat myself. > > All of those would be opt-in, not all projects have such preferences. > This would be similar to our clang-format check > https://invent.kde.org/sysadmin/ci-utilities/-/blob/master/run-clang-format.py?ref_type=heads > that a few projects have adopted (dolphin, Kwin) > > Later I would like to add to those build failures comments on MR with > friendly instructions on how to fix them, or having suggestions, like the > expected version for \since. > > Many FOSS projects have such bots/checks, It would be great to add that to > lessen the reviewer burden while upholding best practices. > > What do you think? > > I think this is good idea. We could also check for the "co authored by a robot" trailers and tell the contributor to avoid those, as per guidelines here: https://community.kde.org/Guidelines_and_HOWTOs/Maintainers_and_Contributions Best regards, - Akseli