<div dir="ltr">I think you could go ahead and do 2 in the interim without waiting for this to reach consensus.<div><br></div><div>In the long run, I suppose I prefer 3. Our doc update system is down at the moment anyway. Might as well leverage github for now.</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, Nov 22, 2019 at 6:40 AM Florian Hahn via llvm-dev <<a href="mailto:llvm-dev@lists.llvm.org">llvm-dev@lists.llvm.org</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div style="overflow-wrap: break-word;">Hi,<div><br></div><div>With multiple proposals to improve the situation for newcomers in flight, let me add another brief proposal:</div><div><br></div><div>Let’s add a CONTRIBUTING.md file to the top-level directory of llvm-project.</div><div><br></div><div>I think this would make the information about how to contribute more visible and Github uses CONTRIBUTING.md to display ‘Contributing Guidelines’ at a few places, like when creating new issues or pull requests (<a href="https://github.blog/2012-09-17-contributing-guidelines/" target="_blank">https://github.blog/2012-09-17-contributing-guidelines/</a>). This would be a suitable place to mention that we are not using Github issues/PRs and point to the current procedures for filing issues and sharing patches.</div><div><br></div><div>If we decide to add a CONTRIBUTING.md file, the next question is what the content should be. We already have a page intended to summarize the information necessary to file bugs and contribute patches: <a href="https://llvm.org/docs/Contributing.html" target="_blank">https://llvm.org/docs/Contributing.html</a></div><div><br></div><div>We could either </div><div><br></div><div>1. Duplicate the content of llvm/docs/Contributing.rst in the CONTRIBUTING.md file (I put up a patch to do that a while ago before the transition to the mono-repo, but abandoned it  because the feedback was that it was not the right time to do it <a href="https://reviews.llvm.org/D59108" target="_blank">https://reviews.llvm.org/D59108</a>)</div><div><br></div><div>2. Have CONTRIBUTING.md mention that Github Issues/PRs are not used at the moment and link to <a href="https://llvm.org/docs/Contributing.html" target="_blank">https://llvm.org/docs/Contributing.html</a>.</div><div><br></div><div>3. Move the contents of llvm/docs/Contributing.rst from the docs to CONTRIBUTING.md. Have <a href="https://llvm.org/docs/Contributing.html" target="_blank">https://llvm.org/docs/Contributing.html</a> redirect to CONTRIBUTING.md on Github.</div><div><br></div><div>Personally I think we should either go with 2. or 3.</div><div><br></div><div>Please let me know what you think!</div><div><br></div><div>Cheers,</div><div>Florian</div></div>_______________________________________________<br>
LLVM Developers mailing list<br>
<a href="mailto:llvm-dev@lists.llvm.org" target="_blank">llvm-dev@lists.llvm.org</a><br>
<a href="https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev" rel="noreferrer" target="_blank">https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-dev</a><br>
</blockquote></div>