Re: CVS commit: pkgsrc/lang/njs

[Leonardo Taccari <leot%NetBSD.org@localhost>]

Hello Sergey,

Sergey A. Osokin writes:
> [...]
> On Thu, Jul 14, 2022 at 12:48:34PM +0200, Leonardo Taccari wrote:
> > Sergey A. Osokin writes:
> > > [...]
> > > Log Message:
> > > lang/njs: update 0.7.3 -> 0.7.5
> > > [...]
> > 
> > When updating packages to a newer version please also provide a summary
> > of changes or changelog in the commit message so readers of
> > pkgsrc-changes@ have an idea to what to expect!
>
> I believe you've already seen my recent commit, so may I have your
> feedback - is it better now?  Thank you.
>
> -------------------------
> Log Message:
> www/nginx: update third-party modules:
>
> o) http_push from 1.2.15 to 1.3.0, [1]
> o) geoip2 from 3.3 to 3.4, [2]
>
> References:
> 1. https://github.com/slact/nchan/compare/v1.2.15...v1.3.0
> 2. https://github.com/leev/ngx_http_geoip2_module/compare/3.3...3.4
>

Please avoid links because they can be precarious and adds a layer of
indirection (it's okay to possibly share them for further information
if a summary is provided but it is important to also share the actual
information without any indirection). The GitHub `compare' thing is
also a list of all single commit messages that... most of the times is
not a nice change summary.

For a possible nicer example please give a look to, e.g.: 

 <https://mail-index.NetBSD.org/pkgsrc-changes/2022/07/14/msg257074.html>

(That's usual the usual and best way to include changelogs and also what
documented in The pkgsrc Guide.)


Thanks!