llvm-project/clang/www/get_involved.html at main · llvm/llvm-project · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
          "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
  <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  <title>Clang - Get Involved</title>
  <link type="text/css" rel="stylesheet" href="menu.css">
  <link type="text/css" rel="stylesheet" href="content.css">
</head>
<body>

<!--#include virtual="menu.html.incl"-->

<div id="content">

<h1>Getting Involved with the Clang Project</h1>

<p>Once you have <a href="get_started.html">checked out and built</a> clang and
played around with it, you might be wondering what you can do to make it better
and contribute to its development.  Alternatively, maybe you just want to follow
the development of the project to see it progress.
</p>

<h2>Contribute</h2>

See the <a href="hacking.html">hacking</a> document for information on how
to author patches.

<h2>Follow what's going on</h2>

<p>Clang is a subproject of the <a href="https://llvm.org">LLVM Project</a>
and has a Discourse forum and mailing list:</p>

<ul>
<li><a href="https://discourse.llvm.org/c/clang/6">Clang Frontend Discourse forum</a> -
This forum is for discussions related to Clang (questions and answers, design
discussions, RFCs, etc).</li>

<li><a href="https://discord.gg/xS7Z362">Discord chat</a> - Real-time chat for
discussions related to Clang (primarily for questions and answers).</li>

<li>Regular meetings are held on the
<a href="https://drive.google.com/file/d/1S7V0MHP4xMs1yUQ9Gv9LHn5bwDfFVapn/view?usp=sharing">
first and third Wednesday</a> of each month to discuss C and C++
standards-related activities happening within the Clang community. These
meetings are a way to coordinate efforts between implementers and provide
updates on how standards activities are going. Meeting agendas and minutes are
available
<a href="https://docs.google.com/document/d/1x5-RbOC6-jnI_NcJ9Dp4pSmGhhNe7lUevuWUIB46TeM/edit?usp=sharing">
here<a>.
</li>

<li><a href="https://llvm.org/docs/GettingInvolved.html#office-hours">Clang office hours</a> -
People within the community hold dedicated office hours at different points
during the month, which is a great way opportunity for getting questions
answered, having more in-depth design discussions, or learning about what's
going on in the community in general.</li>

<li><a href="https://lists.llvm.org/mailman/listinfo/cfe-commits">cfe-commits
</a> - Historical record of commits to Clang and contains early community patch
review commentary.</li>

</ul>

<p>The most common way to talk with other developers on the project is through
the <a href="https://discourse.llvm.org/c/clang/6">Clang Frontend Discourse forum
</a>. The clang forum is a very friendly place and we welcome newcomers. The
forum is archived so you can browse through previous discussions or follow
development on the web if you prefer.</p>

<p>If you're looking for something to work on, check out our <a
href="OpenProjects.html">Open Projects</a> page or look through the <a
href="https://github.com/llvm/llvm-project/issues/">LLVM bug tracker</a>.</p>

<h2 id="criteria">Contributing Extensions to Clang</h2>

<p>Clang is designed to support experimentation,
allowing programmers to easily extend the compiler to support great
new language features and tools. At some point, the authors of these
extensions may propose that the extensions become a part of Clang
itself, to benefit the whole Clang community. However, extensions
(particularly language extensions) have long-term maintenance costs
for Clang. The benefits of the extension need to be evaluated against
these costs. The Clang project uses the following criteria for this
evaluation:</p>
<p>
<ol>
  <li>Evidence of a significant user community: This is based on a number of
  factors, including an existing user community, the perceived likelihood that
  users would adopt such a feature if it were available, and any secondary
  effects that come from, e.g., a library adopting the feature and providing
  benefits to its users.</li>

  <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>

  <li>A 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 implement the feature.</li>

  <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>

  <li>A long-term support plan: increasingly large or complex extensions to
  Clang need matching commitments to supporting them over time, including
  improving their implementation and specification as Clang evolves. The
  capacity of the contributor to make that commitment is as important as the
  commitment itself.</li>

  <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 diagnostics and complete AST
  representations. This is particularly important for language extensions,
  because users will learn how those extensions work through the behavior of the
  compiler.</li>

  <li>A 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>

  <li>A support story for other impacted projects within the monorepo: If the
  extension can impact other parts of the project (libc++, lldb, compiler-rt,
  etc), the proposal needs to document the impact for these projects to fully
  support the extension and what level of support is expected. The impacted
  project communities need to agree with that plan.</li>
</ol>
</p>
<p>
The Clang community uses an RFC process to evaluate potential extensions for
inclusion in the tool. First, write a post in the <code>Clang Frontend</code>
category of <a href="https://discourse.llvm.org/c/clang/6">Discourse</a>. The
title should include <code>[RFC]</code> so it is clear that it is a proposed
change. The post should have detailed information about the change itself, the
motivation for needing the change, how it addresses the criteria listed above,
and any other relevant details the community should be aware of.
</p>
<p>
The community will discuss the proposal in Discourse, asking questions about
the proposal to improve their understanding and giving support or dissent for
the idea. Eventually, consensus will be determined as to whether the proposal
should proceed or be rejected. If a proposal receives little or no feedback,
that typically means that the proposal is rejected due to lack of interest.
</p>
<p>
Sometimes, a consensus position is unclear and the proposal author will need
additional guidance on what next steps to take. In such a case, the Clang Area
Team may get involved. The Clang Area Team secretary will proactively look for
RFCs that appear to not have a clear path forward to add them to the team's
agenda. If anyone would like to put an RFC onto the team's agenda explicitly,
they can tag any one of the <a href="https://github.com/llvm/llvm-project/blob/main/clang/AreaTeamMembers.txt">
Clang Area Team</a> members in a comment on the RFC to get their attention. The
area team will host a meeting to discuss the RFC and determine next steps for
the proposal. In the event no clear community consensus position seems likely
to ever form, the Clang Area Team will make a final judgement call on whether
the RFC will proceed or not. <!-- TODO: link to area team processes -->
</p>
</div>
</body>
</html>