Hi,
A few days ago, we had a discussion about good labelling of PRs/commits in order to make it easier to create News pages for new releases. I just opened PR #601 [1] which changes the API of the v.distance module. Is there a specific label I should put into the subject line of this PR to mark the API change ?
Similar question for PR #534 [2] in which I added new functionality to v.neighbor. I added [NEW FUNCTIONALITY] into the subject line in order to make it apparent, but in a certain way this is redundant with the 'enhancement' tag.
So, could anyone provide some guidance concerning the best way to label/tab/entitle these PRs ?
Moritz
[1] https://github.com/OSGeo/grass/pull/601
[2] https://github.com/OSGeo/grass/pull/534
Hi,
Yes, I would also be very interested in some guidance on this!
Maybe add them also here:
https://github.com/OSGeo/grass/blob/master/CONTRIBUTING.md
Cheers
Stefan
-----Original Message-----
From: grass-dev <grass-dev-bounces@lists.osgeo.org> On Behalf Of Moritz Lennert
Sent: fredag 8. mai 2020 16:41
To: grass-dev <grass-dev@lists.osgeo.org>
Subject: [GRASS-dev] best practices for subject lines of PR
Hi,
A few days ago, we had a discussion about good labelling of PRs/commits in order to make it easier to create News pages for new releases. I just opened PR #601 [1] which changes the API of the v.distance module. Is there a specific label I should put into the subject line of this PR to mark the API change ?
Similar question for PR #534 [2] in which I added new functionality to v.neighbor. I added [NEW FUNCTIONALITY] into the subject line in order to make it apparent, but in a certain way this is redundant with the 'enhancement' tag.
So, could anyone provide some guidance concerning the best way to label/tab/entitle these PRs ?
Moritz
[1] https://github.com/OSGeo/grass/pull/601
[2] https://github.com/OSGeo/grass/pull/534
_______________________________________________
grass-dev mailing list
grass-dev@lists.osgeo.org
https://lists.osgeo.org/mailman/listinfo/grass-dev
On Fri, May 8, 2020 at 1:04 PM Stefan Blumentrath <Stefan.Blumentrath@nina.no> wrote:
Hi,
Yes, I would also be very interested in some guidance on this!
Here are guidelines I wrote for commit messages for Subversion. A lot of it should still apply for both commits and PRs.
https://trac.osgeo.org/grass/wiki/Submitting/General#Commitmessages
Maybe add them also here:
https://github.com/OSGeo/grass/blob/master/CONTRIBUTING.md
Yes, but it is also important to keep the basic contributing file as short as possible. Maybe there should be a detailed guide and a short one.
On 16/05/20 03:32, Vaclav Petras wrote:
On Fri, May 8, 2020 at 1:04 PM Stefan Blumentrath <Stefan.Blumentrath@nina.no <mailto:Stefan.Blumentrath@nina.no>> wrote:
Hi,
Yes, I would also be very interested in some guidance on this!
Here are guidelines I wrote for commit messages for Subversion. A lot of it should still apply for both commits and PRs.
https://trac.osgeo.org/grass/wiki/Submitting/General#Commitmessages
That is a useful general guide, but the recent discussion was concerning labelling commits specifically for making it easier to decide which ones should be part of release news. I don't know if these guidelines are enough for that, or whether we should decide on specific tags (either github tags or [XYZ] tags in the commit message. Maybe MarkusN can give us his opinion as he has the experience of extracting the info.
Moritz
Hi,
On Sat, May 16, 2020 at 2:19 PM Moritz Lennert
<mlennert@club.worldonline.be> wrote:
On 16/05/20 03:32, Vaclav Petras wrote:
> On Fri, May 8, 2020 at 1:04 PM Stefan Blumentrath
> <Stefan.Blumentrath@nina.no <mailto:Stefan.Blumentrath@nina.no>> wrote:
>
> Hi,
>
> Yes, I would also be very interested in some guidance on this!
>
> Here are guidelines I wrote for commit messages for Subversion. A lot of
> it should still apply for both commits and PRs.
>
> https://trac.osgeo.org/grass/wiki/Submitting/General#Commitmessages
That is a useful general guide, but the recent discussion was concerning
labelling commits specifically for making it easier to decide which ones
should be part of release news. I don't know if these guidelines are
enough for that, or whether we should decide on specific tags (either
github tags or [XYZ] tags in the commit message. Maybe MarkusN can give
us his opinion as he has the experience of extracting the info.
Well, for me the labelling is less important than simply useful commit
title messages.
The "Good examples" in the trac page above do 80+% of the job.
As I am closely following the development I usually know what's relevant.
And: others may edit as well 
- in case their favourite
bugfix/enhancement isn't listed.
Best
Markus