[NFC][RemoveDIs] Prefer iterators over inst-pointers in InstCombine
[llvm-project.git] / clang / www / get_involved.html
blobb5212ae97372b3832754cb5d449a97c4375883a9
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
2 "http://www.w3.org/TR/html4/strict.dtd">
3 <html>
4 <head>
5 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6 <title>Clang - Get Involved</title>
7 <link type="text/css" rel="stylesheet" href="menu.css">
8 <link type="text/css" rel="stylesheet" href="content.css">
9 </head>
10 <body>
12 <!--#include virtual="menu.html.incl"-->
14 <div id="content">
16 <h1>Getting Involved with the Clang Project</h1>
18 <p>Once you have <a href="get_started.html">checked out and built</a> clang and
19 played around with it, you might be wondering what you can do to make it better
20 and contribute to its development. Alternatively, maybe you just want to follow
21 the development of the project to see it progress.
22 </p>
24 <h2>Contribute</h2>
26 See the <a href="hacking.html">hacking</a> document for information on how
27 to author patches.
29 <h2>Follow what's going on</h2>
31 <p>Clang is a subproject of the <a href="https://llvm.org">LLVM Project</a>
32 and has a Discourse forum and mailing list:</p>
34 <ul>
35 <li><a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits
36 </a> - This list is for patch submission/discussion.</li>
38 <li><a href="https://discourse.llvm.org/c/clang/6">Clang Frontend Discourse forum</a> -
39 This forum is for everything else Clang related (questions and answers, design
40 discussions, etc).</li>
42 <li>Regular meetings are held on the
43 <a href="https://drive.google.com/file/d/1S7V0MHP4xMs1yUQ9Gv9LHn5bwDfFVapn/view?usp=sharing">
44 first and third Wednesday</a> of each month to discuss C and C++
45 standards-related activities happening within the Clang community. These
46 meetings are a way to coordinate efforts between implementers and provide
47 updates on how standards activities are going. Meeting agendas and minutes are
48 available
49 <a href="https://docs.google.com/document/d/1x5-RbOC6-jnI_NcJ9Dp4pSmGhhNe7lUevuWUIB46TeM/edit?usp=sharing">
50 here<a>.
51 </li>
53 </ul>
55 <p>The most common way to talk with other developers on the project is through
56 the <a href="https://discourse.llvm.org/c/clang/6">Clang Frontend Discourse forum
57 </a>. The clang forum is a very friendly place and we welcome
58 newcomers. In addition to the forum, a significant amount of design
59 discussion takes place on the <a
60 href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits mailing
61 list</a>. All of these lists have archives, so you can browse through previous
62 discussions or follow the list development on the web if you prefer.</p>
64 <p>If you're looking for something to work on, check out our <a
65 href="OpenProjects.html">Open Projects</a> page or look through the <a
66 href="https://github.com/llvm/llvm-project/issues/">LLVM bug tracker</a>.</p>
68 <h2 id="criteria">Contributing Extensions to Clang</h2>
70 <p>Clang is designed to support experimentation,
71 allowing programmers to easily extend the compiler to support great
72 new language features and tools. At some point, the authors of these
73 extensions may propose that the extensions become a part of Clang
74 itself, to benefit the whole Clang community. However, extensions
75 (particularly language extensions) have long-term maintenance costs
76 for Clang. The benefits of the extension need to be evaluated against
77 these costs. The Clang project uses the following criteria for this
78 evaluation:</p>
80 <ol>
81 <li>Evidence of a significant user community: This is based on a number of
82 factors, including an existing user community, the perceived likelihood that
83 users would adopt such a feature if it were available, and any secondary
84 effects that come from, e.g., a library adopting the feature and providing
85 benefits to its users.</li>
87 <li>A specific need to reside within the Clang tree: There are some extensions
88 that would be better expressed as a separate tool, and should remain as
89 separate tools even if they end up being hosted as part of the LLVM umbrella
90 project.</li>
92 <li>A specification: The specification must be sufficient to understand the
93 design of the feature as well as interpret the meaning of specific examples.
94 The specification should be detailed enough that another compiler vendor
95 could implement the feature.</li>
97 <li>Representation within the appropriate governing organization: For
98 extensions to a language governed by a standards committee (C, C++, OpenCL),
99 the extension itself must have an active proposal and proponent within that
100 committee and have a reasonable chance of acceptance. Clang should drive the
101 standard, not diverge from it. This criterion does not apply to all
102 extensions, since some extensions fall outside of the realm of the standards
103 bodies.</li>
105 <li>A long-term support plan: increasingly large or complex extensions to
106 Clang need matching commitments to supporting them over time, including
107 improving their implementation and specification as Clang evolves. The
108 capacity of the contributor to make that commitment is as important as the
109 commitment itself.</li>
111 <li>A high-quality implementation: The implementation must fit well into
112 Clang's architecture, follow LLVM's coding conventions, and meet Clang's
113 quality standards, including diagnostics and complete AST
114 representations. This is particularly important for language extensions,
115 because users will learn how those extensions work through the behavior of the
116 compiler.</li>
118 <li>A test suite: Extensive testing is crucial to ensure that the language
119 extension is not broken by ongoing maintenance in Clang. The test suite
120 should be complete enough that another compiler vendor could conceivably
121 validate their implementation of the feature against it.</li>
122 </ol>
124 </div>
125 </body>
126 </html>