[NeXus-committee] Pull request etiquette

[Osborn, Raymond]

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


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.nexusformat.org/pipermail/nexus-committee/attachments/20241018/fd592753/attachment.htm>