Re: Proposal to have a script to check MR for common mistakes

El dimecres, 12 d’agost del 2026, a les 10:49:52 (Hora d’estiu d’Europa 
central), Méven va escriure:
> >  In particular, how does the "since" check when you have a version like
> 
> dolphin
> which is 26.11.70 but i guess you'd want "since" to say 26.12 ?
> 
> All those are opt-in, for applications \since checks are murch less common
> or useful.

They are less common but not less useful.

In Okular we have public API so correct since ettiquete is welcome.

Can the "since" be told to only worry about some of the particular headers in 
a given set of directories (that is where the public api resides?)

I understand that by default it would exclude _p.h files?

Cheers,
  Albert

> These are meant for Frameworks or Plasma primarily.
> 
> We can add some logic, if needed, to convert 26.11.70 to 26.12 with a
> simple heuristic, as we know dev versions are not to be referred to in API
> documentation.
> 
> Le mer. 12 août 2026 à 00:13, Albert Astals Cid <[email protected]> a écrit :
> > El dimarts, 11 d’agost del 2026, a les 17:45:10 (Hora d’estiu d’Europa
> > 
> > central), Méven va escriure:
> > > 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-forma
> > t
> > .
> > 
> > > 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?
> > 
> > In general, things that save time both to the reviewer and the reviewee
> > are a
> > good thing (i.e. better to have a bot saying that since is missing than a
> > human, the bot will be faster).
> > 
> > In particular, how does the "since" check when you have a version like
> > dolphin
> > which is 26.11.70 but i guess you'd want "since" to say 26.12 ?
> > 
> > Cheers,
> > 
> >   Albert