| Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" |
| 2 | "http://www.w3.org/TR/html4/strict.dtd"> |
| 3 | <html> |
| 4 | <head> |
| Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 5 | <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
| Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 6 | <title>Clang - Get Involved</title> |
| Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 7 | <link type="text/css" rel="stylesheet" href="menu.css"> |
| 8 | <link type="text/css" rel="stylesheet" href="content.css"> |
| Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 9 | </head> |
| 10 | <body> |
| 11 | |
| 12 | <!--#include virtual="menu.html.incl"--> |
| 13 | |
| 14 | <div id="content"> |
| 15 | |
| 16 | <h1>Getting Involved with the Clang Project</h1> |
| 17 | |
| 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> |
| 23 | |
| Stephen Hines | c568f1e | 2014-07-21 00:47:37 -0700 | [diff] [blame] | 24 | <h2>Contribute</h2> |
| 25 | |
| 26 | See the <a href="hacking.html">hacking</a> document for information on how |
| 27 | to author patches. |
| 28 | |
| Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 29 | <h2>Follow what's going on</h2> |
| 30 | |
| 31 | <p>Clang is a subproject of the <a href="http://llvm.org">LLVM Project</a>, but |
| 32 | has its own mailing lists because the communities have people with different |
| 33 | interests. The two clang lists are:</p> |
| 34 | |
| 35 | <ul> |
| 36 | <li><a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits |
| 37 | </a> - This list is for patch submission/discussion.</li> |
| 38 | |
| 39 | <li><a href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev</a> - |
| Douglas Gregor | 3c24cab | 2011-11-02 22:49:47 +0000 | [diff] [blame] | 40 | This list is for everything else Clang related (questions and answers, design |
| 41 | discussions, etc).</li> |
| Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 42 | |
| 43 | </ul> |
| 44 | |
| 45 | <p>If you are interested in clang only, these two lists should be all |
| 46 | you need. If you are interested in the LLVM optimizer and code generator, |
| 47 | please consider signing up for <a |
| 48 | href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev">llvmdev</a> and <a |
| 49 | href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits">llvm-commits</a> |
| 50 | as well.</p> |
| 51 | |
| 52 | |
| 53 | <p>The best way to talk with other developers on the project is through the <a |
| 54 | href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-dev">cfe-dev mailing |
| 55 | list</a>. The clang mailing list is a very friendly place and we welcome |
| 56 | newcomers. In addition to the cfe-dev list, a significant amount of design |
| 57 | discussion takes place on the <a |
| 58 | href="http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits">cfe-commits mailing |
| 59 | list</a>. All of these lists have archives, so you can browse through previous |
| 60 | discussions or follow the list development on the web if you prefer.</p> |
| 61 | |
| Stephen Hines | 651f13c | 2014-04-23 16:59:28 -0700 | [diff] [blame] | 62 | <p>You can also follow the <a href="http://planet.clang.org/">Planet Clang</a> |
| 63 | community news feed which offers a window into the world, work and lives of |
| 64 | Clang developers, contributors and the standards they implement.</p> |
| 65 | |
| 66 | <p>If you're looking for something to work on, check out our <a |
| 67 | href="OpenProjects.html">Open Projects</a> page or look through the <a |
| 68 | href="http://llvm.org/bugs/">Bugzilla bug database</a>.</p> |
| Douglas Gregor | 40619f3 | 2011-07-23 19:21:07 +0000 | [diff] [blame] | 69 | |
| Benjamin Kramer | 665a8dc | 2012-01-15 15:26:07 +0000 | [diff] [blame] | 70 | <h2 id="criteria">Contributing Extensions to Clang</h2> |
| Douglas Gregor | 40619f3 | 2011-07-23 19:21:07 +0000 | [diff] [blame] | 71 | |
| 72 | <p>Clang has always been designed as a platform for experimentation, |
| 73 | allowing programmers to easily extend the compiler to support great |
| 74 | new language features and tools. At some point, the authors of these |
| 75 | extensions may propose that the extensions become a part of Clang |
| 76 | itself, to benefit the whole Clang community. But not every idea--not |
| 77 | even every great idea--should become part of Clang. Extensions |
| 78 | (particularly language extensions) pose a long-term maintenance burden |
| 79 | on Clang, and therefore the benefits of the extension must outweight |
| 80 | those costs. Hence, these are the seven criteria used to evaluate the |
| 81 | merits of a proposed extension:</p> |
| 82 | |
| 83 | <ol> |
| 84 | <li>Evidence of a significant user community: This is based on a number of factors, including an actual, existing user community, the perceived likelihood that users would adopt such a feature if it were available, and any "trickle-down" effects that come from, e.g., a library adopting the feature and providing benefits to its users.</li> |
| 85 | |
| 86 | <li>A specific need to reside within the Clang tree: There are some extensions that would be better expressed as a separate tool, and should remain as separate tools even if they end up being hosted as part of the LLVM umbrella project.</li> |
| 87 | |
| 88 | <li>A complete specification: The specification must be sufficient to understand the design of the feature as well as interpret the meaning of specific examples. The specification should be detailed enough that another compiler vendor could conceivably implement the feature.</li> |
| 89 | |
| 90 | <li>Representation within the appropriate governing organization: For extensions to a language governed by a standards committee (C, C++, OpenCL), the extension itself must have an active proposal and proponent within that committee and have a reasonable chance of acceptance. Clang should drive the standard, not diverge from it. This criterion does not apply to all extensions, since some extensions fall outside of the realm of the standards bodies.</li> |
| 91 | |
| 92 | <li>A long-term support plan: Contributing a non-trivial extension to Clang implies a commitment to supporting that extension, improving the implementation and specification as Clang evolves. The capacity of the contributor to make that commitment is as important as the commitment itself.</li> |
| 93 | |
| 94 | <li>A high-quality implementation: The implementation must fit well into Clang's architecture, follow LLVM's coding conventions, and meet Clang's quality standards, including high-quality diagnostics and rich AST representations. This is particularly important for language extensions, because users will learn how those extensions work through the behavior of the compiler.</li> |
| 95 | |
| 96 | <li>A proper test suite: Extensive testing is crucial to ensure that the language extension is not broken by ongoing maintenance in Clang. The test suite should be complete enough that another compiler vendor could conceivably validate their implementation of the feature against it.</li> |
| 97 | </ol> |
| Cedric Venet | 3d65864 | 2009-02-14 20:20:19 +0000 | [diff] [blame] | 98 | |
| 99 | </div> |
| 100 | </body> |
| 101 | </html> |