XZise created this task.
XZise added a subscriber: XZise.
XZise added projects: pywikibot-core, Continuous-Integration-Config.
Herald added subscribers: pywikibot-bugs-list, Aklapper.

TASK DESCRIPTION
  After d3f9b7f0 was merged with an unfortunately long commit message I thought 
we might be able to check the style of the commit message using Jenkins. Afaik 
that job should be voting as I don't see a reason why it should be allowed to 
be merged without applying them. There is basically one exception and that is 
mentioning URLs with the line length. These are the tests which seem sensible:
  
  * If there is a `^Bug: T\d+$ line it should be together with the Change-Id.
  * Preferably it should check if the bug id is valid although that might be to 
complex. But at least it should have the T-prefix.
  * The line length should be below (or at?) 80 of all lines.
  * There should be no `I…` references but instead always git commit hashes.
  * The Change-Id must be separated by at least one line from the first line. 
Alternatively every line in the paragraph together with the Change-Id must 
match `^.+: .+$`.
  * The second line is a blank line (aka `\A[^\n]+\n\n`).
  * Commit hashes which point to commits in pywikibot should only point to past 
(merged) commits.
  
  Regarding the references being git commit hashes, my argumentation is that 
the `I…` prefix only work on gerrit. But if you work locally or on github it 
won't work. Git hashes on the other hand will also work on gerrit (afaik if 
they contain at least one letter) but also work on phabricator and github 
directly as links. You can also directly use them locally instead of searching 
for the change-id. And searching locally with change-id will only work when the 
commit with that id is the current commit or an ancestor. While a commit hash 
will also work when it's in another branch.
  
  Git commit hashes won't work on github though if they point to another 
repository (e.g. to reference a change to MediaWiki) but a change-id doesn't 
work too so it's not lost functionality. There has been afaik the argument that 
you can see it's visible that it's not a pywikibot commit hash (as that could 
be a commit hash) but then it may be that someone overlooked it and referenced 
commits to pywikibot with the change-id. And this can be avoided by mentioning 
the project together with it like “…after it was added in mediawiki 
(abcedf12)”. The change-id and commit hash are themselves useless when the 
commit is shown outside WMF's Gerrit.

TASK DETAIL
  https://phabricator.wikimedia.org/T109119

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: XZise
Cc: Aklapper, pywikibot-bugs-list, XZise, jayvdb, hashar, greg, Malyacko



_______________________________________________
pywikibot-bugs mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/pywikibot-bugs

Reply via email to