Skip to content

Commit effcdc3

Browse files
committed
Add contributing info to CONTRIBUTING.md and README.md
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 Reviewers: tonic, rnk, jhenderson, meikeb Reviewed By: rnk, jhenderson, meikeb Differential Revision: https://reviews.llvm.org/D70743
1 parent aca7aab commit effcdc3

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

CONTRIBUTING.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Contributing to LLVM
2+
3+
Thank you for your interest in contributing to LLVM! There are many ways to
4+
contribute, and we appreciate all contributions.
5+
6+
To get started with contributing, please take a look at the
7+
[Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide. It
8+
describes how to get involved, raise issues and submit patches. Please note
9+
that at the moment the LLVM project does not use either Github pull requests
10+
or Github issues.

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ This directory and its subdirectories contain source code for LLVM,
44
a toolkit for the construction of highly optimized compilers,
55
optimizers, and runtime environments.
66

7+
The README briefly describes how to get started with building LLVM.
8+
For more information on how to contribute to the LLVM project, please
9+
take a look at the
10+
[Contributing to LLVM](https://llvm.org/docs/Contributing.html) guide.
11+
712
## Getting Started with the LLVM System
813

914
Taken from https://llvm.org/docs/GettingStarted.html.

0 commit comments

Comments
 (0)