<p dir="ltr">I second this as the minimum requirement. Every PR should reference an issue.</p>
<p dir="ltr">Issues describe "why" this is important.</p>
<p dir="ltr">PRs describe "how" the issue is handled.</p>
<p dir="ltr">The most expensive question is "why". In current practice, this context is omitted far too often.</p>
<br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, Oct 18, 2024, 11:38 AM Osborn, Raymond via NeXus-committee <<a href="mailto:nexus-committee@shadow.nd.rl.ac.uk">nexus-committee@shadow.nd.rl.ac.uk</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">





<div lang="EN-US" link="#467886" vlink="#96607D" style="word-wrap:break-word">
<div class="m_-6273596068448007470WordSection1">
<p class="MsoNormal">I would like to suggest that we require all pull requests to have a detailed description of what is being proposed and why. It is becoming impossible to understand the context of many of the PRs, whose conversations fill my inbox every
 day. Sometimes there are links to other related PRs or issues, but these often contain no description either.
<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">I think the assumption is that these are things that were either discussed at the recent NIAC or in a telco, but even if we were present, it can be difficult to remember them all and those who weren’t present have no chance of knowing what
 is going on. Detailed descriptions are also important as a historical record of why we make the decisions that we do.<u></u><u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal">Ray<u></u><u></u></p>
<div>
<div>
<p class="MsoNormal"><span>-- <br>
Ray Osborn, Senior Scientist<br>
Materials Science Division<br>
Argonne National Laboratory<br>
Lemont, IL 60439, USA<br>
Phone: +1 (630) 252-9011<br>
Email: <a href="mailto:ROsborn@anl.gov" target="_blank" rel="noreferrer">ROsborn@anl.gov</a><u></u><u></u></span></p>
</div>
</div>
<p class="MsoNormal"><u></u> <u></u></p>
<p class="MsoNormal"><u></u> <u></u></p>
</div>
</div>

_______________________________________________<br>
NeXus-committee mailing list<br>
<a href="mailto:NeXus-committee@nexusformat.org" target="_blank" rel="noreferrer">NeXus-committee@nexusformat.org</a><br>
<a href="https://lists.nexusformat.org/mailman/listinfo/nexus-committee" rel="noreferrer noreferrer" target="_blank">https://lists.nexusformat.org/mailman/listinfo/nexus-committee</a><br>
</blockquote></div>