[NeXus-committee] Pull request etiquette

[Aaron Brewster]

Thirded!  For all the above reasons.

On Fri, Oct 18, 2024 at 10:30 AM Pete Jemian via NeXus-committee <
nexus-committee at shadow.nd.rl.ac.uk> wrote:

> I second this as the minimum requirement. Every PR should reference an
> issue.
>
> Issues describe "why" this is important.
>
> PRs describe "how" the issue is handled.
>
> The most expensive question is "why". In current practice, this context is
> omitted far too often.
>
> On Fri, Oct 18, 2024, 11:38 AM Osborn, Raymond via NeXus-committee <
> nexus-committee at shadow.nd.rl.ac.uk> wrote:
>
>> 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.
>>
>>
>>
>> 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.
>>
>>
>>
>> Ray
>>
>> --
>> Ray Osborn, Senior Scientist
>> Materials Science Division
>> Argonne National Laboratory
>> Lemont, IL 60439, USA
>> Phone: +1 (630) 252-9011
>> Email: ROsborn at anl.gov
>>
>>
>>
>>
>> _______________________________________________
>> NeXus-committee mailing list
>> NeXus-committee at nexusformat.org
>> https://lists.nexusformat.org/mailman/listinfo/nexus-committee
>>
> _______________________________________________
> NeXus-committee mailing list
> NeXus-committee at nexusformat.org
> https://lists.nexusformat.org/mailman/listinfo/nexus-committee
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.nexusformat.org/pipermail/nexus-committee/attachments/20241021/26145a49/attachment.htm>