<html xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Generator" content="Microsoft Word 15 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Aptos;
panose-1:2 11 0 4 2 2 2 2 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
font-size:12.0pt;
font-family:"Aptos",sans-serif;}
a:link, span.MsoHyperlink
{mso-style-priority:99;
color:blue;
text-decoration:underline;}
span.EmailStyle19
{mso-style-type:personal-reply;
font-family:"Aptos",sans-serif;
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;
font-size:10.0pt;
mso-ligatures:none;}
@page WordSection1
{size:8.5in 11.0in;
margin:1.0in 1.0in 1.0in 1.0in;}
div.WordSection1
{page:WordSection1;}
--></style>
</head>
<body lang="EN-US" link="blue" vlink="purple" style="word-wrap:break-word">
<div class="WordSection1">
<p class="MsoNormal"><span style="font-size:11.0pt">In our group, we setup pull request template and issue templates for each repo (can also be done at the org level), and the template contains the instructions on how to proceed. In the extreme case, `lmfit`
has a very good example on how to **force** contributors to follow the instructions:<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"><a href="https://github.com/lmfit/lmfit-py/blob/master/.github/ISSUE_TEMPLATE.md">https://github.com/lmfit/lmfit-py/blob/master/.github/ISSUE_TEMPLATE.md</a><o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"><a href="https://github.com/lmfit/lmfit-py/blob/master/.github/PULL_REQUEST_TEMPLATE.md">https://github.com/lmfit/lmfit-py/blob/master/.github/PULL_REQUEST_TEMPLATE.md</a><o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">Cheers,<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt">Chen<o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p>
<div>
<div>
<p class="MsoNormal">-- <o:p></o:p></p>
</div>
<div>
<p class="MsoNormal">Chen Zhang<o:p></o:p></p>
<p class="MsoNormal">Computational Scientist<o:p></o:p></p>
<p class="MsoNormal">Computing and Computational Sciences Directorate<o:p></o:p></p>
</div>
</div>
<p class="MsoNormal">Oak Ridge National Lab<span style="font-size:11.0pt"><o:p></o:p></span></p>
<p class="MsoNormal"><span style="font-size:11.0pt"><o:p> </o:p></span></p>
<div id="mail-editor-reference-message-container">
<div>
<div>
<div style="border:none;border-top:solid #B5C4DF 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal" style="margin-bottom:12.0pt"><b><span style="color:black">From:
</span></b><span style="color:black">NeXus-committee <nexus-committee-bounces@shadow.nd.rl.ac.uk> on behalf of Paul Millar via NeXus-committee <nexus-committee@shadow.nd.rl.ac.uk><br>
<b>Date: </b>Tuesday, October 22, 2024 at 12:53</span><span style="font-family:"Arial",sans-serif;color:black"> </span><span style="color:black">PM<br>
<b>To: </b>nexus-committee@nexusformat.org <nexus-committee@nexusformat.org><br>
<b>Subject: </b>[EXTERNAL] Re: [NeXus-committee] Pull request etiquette<o:p></o:p></span></p>
</div>
<div>
<p class="MsoNormal"><span style="font-size:11.0pt">Just FYI,<br>
<br>
Information on how people may contribute to a project is (by convention) <br>
often recorded in the 'CONTRIBUTING' or 'CONTRIBUTING.md' file (if <br>
markdown is used). This is a file stored in the repo's root directory, <br>
much like README / README.md.<br>
<br>
Amongst other things, the 'CONTRIBUTING.md' file often describes what is <br>
expected when proposing a change. So, a policy requiring that an issue <br>
is created first would (I think) naturally be documented in that file.<br>
<br>
HTH,<br>
Paul.<br>
<br>
On 22/10/2024 02.05, Aaron Brewster via NeXus-committee wrote:<br>
> Thirded! For all the above reasons.<br>
><br>
> On Fri, Oct 18, 2024 at 10:30</span><span style="font-size:11.0pt;font-family:"Arial",sans-serif"> </span><span style="font-size:11.0pt">AM Pete Jemian via NeXus-committee
<br>
> <nexus-committee@shadow.nd.rl.ac.uk> wrote:<br>
><br>
> I second this as the minimum requirement. Every PR should<br>
> reference an issue.<br>
><br>
> Issues describe "why" this is important.<br>
><br>
> PRs describe "how" the issue is handled.<br>
><br>
> The most expensive question is "why". In current practice, this<br>
> context is omitted far too often.<br>
><br>
><br>
> On Fri, Oct 18, 2024, 11:38</span><span style="font-size:11.0pt;font-family:"Arial",sans-serif"> </span><span style="font-size:11.0pt">AM Osborn, Raymond via NeXus-committee<br>
> <nexus-committee@shadow.nd.rl.ac.uk> wrote:<br>
><br>
> I would like to suggest that we require all pull requests to<br>
> have a detailed description of what is being proposed and why.<br>
> It is becoming impossible to understand the context of many of<br>
> the PRs, whose conversations fill my inbox every day.<br>
> Sometimes there are links to other related PRs or issues, but<br>
> these often contain no description either.<br>
><br>
> I think the assumption is that these are things that were<br>
> either discussed at the recent NIAC or in a telco, but even if<br>
> we were present, it can be difficult to remember them all and<br>
> those who weren’t present have no chance of knowing what is<br>
> going on. Detailed descriptions are also important as a<br>
> historical record of why we make the decisions that we do.<br>
><br>
> Ray<br>
><br>
> -- <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: ROsborn@anl.gov<br>
><br>
> _______________________________________________<br>
> NeXus-committee mailing list<br>
> NeXus-committee@nexusformat.org<br>
> <a href="https://urldefense.us/v2/url?u=https-3A__lists.nexusformat.org_mailman_listinfo_nexus-2Dcommittee&d=DwIGaQ&c=v4IIwRuZAmwupIjowmMWUmLasxPEgYsgNI-O7C4ViYc&r=oSSxa7CTOFRP-tS_6Kp7Gw&m=NKa4ti00538uOxZxa84PPoobuZT-I4rwGOw_ghlEZb-FlYiNoRKQjmRoJmJpvLO7&s=ImsBZ0o0-AesJ7LLuP1CQahmjUl6eph0sdSAKInrCRU&e=">
https://urldefense.us/v2/url?u=https-3A__lists.nexusformat.org_mailman_listinfo_nexus-2Dcommittee&d=DwIGaQ&c=v4IIwRuZAmwupIjowmMWUmLasxPEgYsgNI-O7C4ViYc&r=oSSxa7CTOFRP-tS_6Kp7Gw&m=NKa4ti00538uOxZxa84PPoobuZT-I4rwGOw_ghlEZb-FlYiNoRKQjmRoJmJpvLO7&s=ImsBZ0o0-AesJ7LLuP1CQahmjUl6eph0sdSAKInrCRU&e=</a>
<br>
><br>
> _______________________________________________<br>
> NeXus-committee mailing list<br>
> NeXus-committee@nexusformat.org<br>
> <a href="https://urldefense.us/v2/url?u=https-3A__lists.nexusformat.org_mailman_listinfo_nexus-2Dcommittee&d=DwIGaQ&c=v4IIwRuZAmwupIjowmMWUmLasxPEgYsgNI-O7C4ViYc&r=oSSxa7CTOFRP-tS_6Kp7Gw&m=NKa4ti00538uOxZxa84PPoobuZT-I4rwGOw_ghlEZb-FlYiNoRKQjmRoJmJpvLO7&s=ImsBZ0o0-AesJ7LLuP1CQahmjUl6eph0sdSAKInrCRU&e=">
https://urldefense.us/v2/url?u=https-3A__lists.nexusformat.org_mailman_listinfo_nexus-2Dcommittee&d=DwIGaQ&c=v4IIwRuZAmwupIjowmMWUmLasxPEgYsgNI-O7C4ViYc&r=oSSxa7CTOFRP-tS_6Kp7Gw&m=NKa4ti00538uOxZxa84PPoobuZT-I4rwGOw_ghlEZb-FlYiNoRKQjmRoJmJpvLO7&s=ImsBZ0o0-AesJ7LLuP1CQahmjUl6eph0sdSAKInrCRU&e=</a>
<br>
><br>
><br>
> _______________________________________________<br>
> NeXus-committee mailing list<br>
> NeXus-committee@nexusformat.org<br>
> <a href="https://urldefense.us/v2/url?u=https-3A__lists.nexusformat.org_mailman_listinfo_nexus-2Dcommittee&d=DwIGaQ&c=v4IIwRuZAmwupIjowmMWUmLasxPEgYsgNI-O7C4ViYc&r=oSSxa7CTOFRP-tS_6Kp7Gw&m=NKa4ti00538uOxZxa84PPoobuZT-I4rwGOw_ghlEZb-FlYiNoRKQjmRoJmJpvLO7&s=ImsBZ0o0-AesJ7LLuP1CQahmjUl6eph0sdSAKInrCRU&e=">
https://urldefense.us/v2/url?u=https-3A__lists.nexusformat.org_mailman_listinfo_nexus-2Dcommittee&d=DwIGaQ&c=v4IIwRuZAmwupIjowmMWUmLasxPEgYsgNI-O7C4ViYc&r=oSSxa7CTOFRP-tS_6Kp7Gw&m=NKa4ti00538uOxZxa84PPoobuZT-I4rwGOw_ghlEZb-FlYiNoRKQjmRoJmJpvLO7&s=ImsBZ0o0-AesJ7LLuP1CQahmjUl6eph0sdSAKInrCRU&e=</a>
<br>
<br>
_______________________________________________<br>
NeXus-committee mailing list<br>
NeXus-committee@nexusformat.org<br>
<a href="https://urldefense.us/v2/url?u=https-3A__lists.nexusformat.org_mailman_listinfo_nexus-2Dcommittee&d=DwIGaQ&c=v4IIwRuZAmwupIjowmMWUmLasxPEgYsgNI-O7C4ViYc&r=oSSxa7CTOFRP-tS_6Kp7Gw&m=NKa4ti00538uOxZxa84PPoobuZT-I4rwGOw_ghlEZb-FlYiNoRKQjmRoJmJpvLO7&s=ImsBZ0o0-AesJ7LLuP1CQahmjUl6eph0sdSAKInrCRU&e=">https://urldefense.us/v2/url?u=https-3A__lists.nexusformat.org_mailman_listinfo_nexus-2Dcommittee&d=DwIGaQ&c=v4IIwRuZAmwupIjowmMWUmLasxPEgYsgNI-O7C4ViYc&r=oSSxa7CTOFRP-tS_6Kp7Gw&m=NKa4ti00538uOxZxa84PPoobuZT-I4rwGOw_ghlEZb-FlYiNoRKQjmRoJmJpvLO7&s=ImsBZ0o0-AesJ7LLuP1CQahmjUl6eph0sdSAKInrCRU&e=</a>
<o:p></o:p></span></p>
</div>
</div>
</div>
</div>
</div>
</body>
</html>