lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Steve Rowe (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (LUCENE-5383) fix changes2html to link pull requests
Date Sat, 04 Jan 2014 21:01:50 GMT

    [ https://issues.apache.org/jira/browse/LUCENE-5383?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13862417#comment-13862417
] 

Steve Rowe commented on LUCENE-5383:
------------------------------------

{quote}
bq. I would suggest a convention of "github pull req #xxx" may help clarify longer term.

I don't think we should make this complicated without good reason. We should use consistent
naming in CHANGES.txt and in commit messages like we do today, and it should also be recognized
by github so the contributor knows we actually committed the thing.
{quote}

Adding the word "github" is complicated?  Um, I don't think so.  

However, since "pull request" is AFAICT synonymous in the current context with "github pull
request", and this is likely IMHO to be the case for years, we should not require committers
to include "github" in {{CHANGES.txt}} entries to get pull request references linked to github
pull requests.

Does Github describe their commit message pull request reference syntax anywhere?  I did lots
of searching and couldn't find it (I only found stuff about how to refer to/close *issues*
from commit messages).  Apparently case-insensitive "pull request # <num>" is one form,
but maybe the '#' isn't required, maybe PR would work instead of "pull request", etc.

> fix changes2html to link pull requests
> --------------------------------------
>
>                 Key: LUCENE-5383
>                 URL: https://issues.apache.org/jira/browse/LUCENE-5383
>             Project: Lucene - Core
>          Issue Type: Improvement
>            Reporter: Robert Muir
>
> If someone submits a pull request, i think we should put it in changes.txt in some way
similar to the jira issues:
> e.g. for a JIRA issue we do:
> {noformat}
> * LUCENE-XXXX: Add FooBar.  (Joe Contributor via John Committer)
> {noformat}
> changes2html recognizes and expands these to jira issue links.
> so I think we should be able to do something like:
> {noformat}
> * pull request #xxx: Add FooBar. (Joe Contributor via John Committer)
> {noformat}
> and have it link to the request, too.



--
This message was sent by Atlassian JIRA
(v6.1.5#6160)

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org


Mime
View raw message