Add contributing info to CONTRIBUTING.md and README.md

[fhahn]

Summary

As discussed on llvm-dev [1], this patch adds a brief CONTRIBUTING.md to
the top-level of the repo, with a pointer to Contributing.html. This
should make it easier to discover the contributing information and also
be highlighted in the Github UI.

It also updates README.md to link to Contributing.html.

[1] http://lists.llvm.org/pipermail/llvm-dev/2019-November/137141.html

[1480c1]

It seems that GitHub issues are open though?

[merge_guards_bot]

Build result: pass - 60328 tests passed, 0 failed and 732 were skipped.

Log files: console-log.txt, CMakeCache.txt

[rnk]

In D70743#1760789, @1480c1 wrote:

It seems that GitHub issues are open though?

I see some recent issues (https://github.com/llvm/llvm-project/issues/41), but there was no announcement, so I would say that this note is accurate for now: it says we don't use it "at the moment", which is true.

CONTRIBUTING.md

10

I think it's: "... project does not use either Github pull requests or Github issues"

[jhenderson]

CONTRIBUTING.md

10

Or: "... project uses neither Github pull requests not Github issues"

Both are correct, I believe!

[fhahn]

Reword to use 'does not use either ... or ..,

[fhahn]

CONTRIBUTING.md

10

Ah yes, the does in the original wording was off! I went with Reid's suggestion, as including the does not makes the wording a bit more obvious I think.

[jhenderson]

LGTM, but might want someone else to give a thumbs up too.

[merge_guards_bot]

Build result: pass - 60332 tests passed, 0 failed and 732 were skipped.

Log files: console-log.txt, CMakeCache.txt

[rnk]

lgtm, thanks!

[meikeb]

Great addition! Could you add a "Contributing" section with a link to CONTRIBUTING.md to README.md for better visibility?

[fhahn]

In D70743#1762558, @meikeb wrote:

Great addition! Could you add a "Contributing" section with a link to CONTRIBUTING.md to README.md for better visibility?

Yes that was one change I wanted to do as a follow up. But I can add it here as well!

[fhahn]

Add reference to CONTRIBUTING.md to README.md

[fhahn]

In D70743#1762609, @fhahn wrote:

In D70743#1762558, @meikeb wrote:

Great addition! Could you add a "Contributing" section with a link to CONTRIBUTING.md to README.md for better visibility?

Yes that was one change I wanted to do as a follow up. But I can add it here as well!

I've added a reference to CONTRIBUTING.md to the README. I am undecided if it's better to link to CONTRIBUTING.md or Contributing.html directly. Given that CONTRIBUTING.md mostly just links to Contributing.html, should we link directly to that page? What do you think?

[meikeb]

In D70743#1762664, @fhahn wrote:

In D70743#1762609, @fhahn wrote:

In D70743#1762558, @meikeb wrote:

Great addition! Could you add a "Contributing" section with a link to CONTRIBUTING.md to README.md for better visibility?

Yes that was one change I wanted to do as a follow up. But I can add it here as well!

I've added a reference to CONTRIBUTING.md to the README. I am undecided if it's better to link to CONTRIBUTING.md or Contributing.html directly. Given that CONTRIBUTING.md mostly just links to Contributing.html, should we link directly to that page? What do you think?

You have a good point. I think linking directly to Contributing.html might be more helpful. I still think it makes sense to bundle both into one change though.

[fhahn]

Update link in readme to point to Contributing.html

[fhahn]

In D70743#1762703, @meikeb wrote:

You have a good point. I think linking directly to Contributing.html might be more helpful. I still think it makes sense to bundle both into one change though.

Great, I think so as well! Updated.

[jhenderson]

README.md

9

Not sure, but maybe the link should be "Contributing to LLVM" to match the doc title, followed by the word "guide"?

[meikeb]

This looks good to me now, except maybe for the wording change suggested by jhenderson.

[fhahn]

Change [Contributing Guide](..) to [Contributing to LLVM](..) guide.

[jhenderson]

LGTM, thanks!

[fhahn]

Thanks for all the feedback :)

CONTRIBUTING.md

+# Contributing to LLVM
+
+Thank you for your interest in contributing to LLVM! There are many ways to
+contribute, and we appreciate all contributions.
+
+To get started with contributing, please take a look at the
+[Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide. It
+describes how to get involved, raise issues and submit patches. Please note
+that at the moment the LLVM project does not use either Github pull requests
+or Github issues.

README.md

 # The LLVM Compiler Infrastructure
 
 This directory and its subdirectories contain source code for LLVM,
 a toolkit for the construction of highly optimized compilers,
 optimizers, and runtime environments.
 
+The README briefly describes how to get started with building LLVM.
+For more information on how to contribute to the LLVM project, please
+take a look at the
+[Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.
+
 ## Getting Started with the LLVM System
 
 Taken from https://llvm.org/docs/GettingStarted.html.
 
 ### Overview
 
 Welcome to the LLVM project!