Format of pull request titles

[Antonin Delpeuch (lists)]

Hello all,

I am not aware of any existing guidelines for pull request titles in
OpenRefine, but I would like to open the discussion about it. What are
your preferences about PR titles? For me, it is important that the PR
title is descriptive on its own (instead of just "Fixes #2326").

Antoine has recently started to enforce a format which looks like
"(I#2326) Support custom rank in Wikidata schema", and it is great to
have a bit of order there!

I have noticed that when we merge the pull request, GitHub does not link
the issue number to the issue, perhaps because of the leading "I"
character (see for instance
https://github.com/OpenRefine/OpenRefine/commit/f2e5de2f6f347dcb318729f0ddcc9df170233263,
where it is only linked in the body of the commit message, not the title).

Could we perhaps come up with a different format which would allow this
linking? GitHub appends the pull request number in brackets at the end
of the PR title, so perhaps it is confusing if we have the same format
for the issue number, but I wonder if we could instead use "[#2326]
Support custom rank in Wikidata schema", or something like this?

Cheers,

Antonin

[Antoine Beaubien]

Hi Antonin,

   I don't understand. I thought that it was not the title, but to description of a pull request that triggered the automatic closing.

I checked the GitHub docs :

https://github.blog/2013-01-22-closing-issues-via-commit-messages/

https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword

There is even the list of accepted words that trigger that function.

Specifically the docs says this:

• You can link a pull request to an issue by using a supported keyword in the pull request's description or in a commit message (please note that the pull request must be on the default branch).
  • close, closes, closed, fix, fixes, fixed, resolve, resolves, resolved
• If you use a keyword to reference a pull request comment in another pull request, the pull requests will be linked. Merging the referencing pull request will also close the referenced pull request.

(I find interesting the fact that you can link PR together, if I understand that correctly.)

But, no where do they talk about the title. Still, I went to see the link you post, and I see that the automatic closing of the related issue wasn't triggered.

Do you really think the naming of the title is the problem here? If so, I can rename every pull request that starts with (I#xx) to another schema.

Regards,

   Antoine

[Antonin Delpeuch (lists)]

Hi Antoine,

Indeed, the title is not used for automatic closing.

However, the title does generate hypertext links (<a href…) when references to issues or pull requests are made there.

All I am saying is that with the format you are introducing, those hypertext links to the issue number are not inserted.

Is that any clearer?

Antonin

--
You received this message because you are subscribed to the Google Groups "OpenRefine Development" group.
To unsubscribe from this group and stop receiving emails from it, send an email to openrefine-de...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/openrefine-dev/a938d4a1-903e-49ee-81e4-c6f0ad530c39n%40googlegroups.com.

[Antoine Beaubien]

Hi Antonin,

  On another GH project, I've seen this usage:

It seams to be the format you suggest.

In the link you provided, you said that GH didn't link to the issue. You mean like this, where (I#4339) is not linked, like on the next line where Fixes... show the link?

I tried to use brackets and add a space in the title of this pr: « [I #387] No error message when you have 5 or less rows #4704 »

https://github.com/OpenRefine/OpenRefine/pull/4704

And going to check his last commit, I get this:

I'm not sure I understand this problem correctly.

Regards,

   Antoine