Skip to content

Commit 1d89d7d

Browse files
authored
[Docs] Explain how to propose an extension in Clang (#130803)
We have a list of criteria for proposing an extension in Clang, but we do not have any documentation about how to propose an extension. This adds some basic documentation about how we run RFCs in Clang, as well as adds a list of Clang Area Team members in support of the process. It could be argued that this should be documented for the entire LLVM Project, however, other parts of the project have different rules for proposing extensions. (Extending libc++ is a different proposition than extending LLVM, than extending MLIR, than extending Clang, etc.) We may want to introduce high-level documentation for the LLVM Project, but that is a bigger project and we already have the documentation in Clang about criteria for extensions. So it seems reasonable to add some lightweight documentation specific to Clang until we determine what to do at the whole project level.
1 parent 6bf0c46 commit 1d89d7d

File tree

2 files changed

+48
-2
lines changed

2 files changed

+48
-2
lines changed

clang/AreaTeamMembers.txt

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
This is a list of the current Clang Area Team members.
2+
3+
Chair
4+
-----
5+
Aaron Ballman
6+
[email protected] (email), AaronBallman (Discourse), AaronBallman (GitHub), AaronBallman (Discord)
7+
8+
Secretary
9+
---------
10+
Reid Kleckner
11+
[email protected] (email), rnk (Discourse), rnk (GitHub), rnk (Discord)
12+
13+
Other Members
14+
-------------
15+
Eli Friedman
16+
[email protected]> (email), efriedma-quic (Discourse), efriedma-quic (GitHub)
17+

clang/www/get_involved.html

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ <h2 id="criteria">Contributing Extensions to Clang</h2>
8383
for Clang. The benefits of the extension need to be evaluated against
8484
these costs. The Clang project uses the following criteria for this
8585
evaluation:</p>
86-
86+
<p>
8787
<ol>
8888
<li>Evidence of a significant user community: This is based on a number of
8989
factors, including an existing user community, the perceived likelihood that
@@ -133,7 +133,36 @@ <h2 id="criteria">Contributing Extensions to Clang</h2>
133133
support the extension and what level of support is expected. The impacted
134134
project communities need to agree with that plan.</li>
135135
</ol>
136-
136+
</p>
137+
<p>
138+
The Clang community uses an RFC process to evaluate potential extensions for
139+
inclusion in the tool. First, write a post in the <code>Clang Frontend</code>
140+
category of <a href="https://discourse.llvm.org/c/clang/6">Discourse</a>. The
141+
title should include <code>[RFC]</code> so it is clear that it is a proposed
142+
change. The post should have detailed information about the change itself, the
143+
motivation for needing the change, how it addresses the criteria listed above,
144+
and any other relevant details the community should be aware of.
145+
</p>
146+
<p>
147+
The community will discuss the proposal in Discourse, asking questions about
148+
the proposal to improve their understanding and giving support or dissent for
149+
the idea. Eventually, consensus will be determined as to whether the proposal
150+
should proceed or be rejected. If a proposal receives little or no feedback,
151+
that typically means that the proposal is rejected due to lack of interest.
152+
</p>
153+
<p>
154+
Sometimes, a consensus position is unclear and the proposal author will need
155+
additional guidance on what next steps to take. In such a case, the Clang Area
156+
Team may get involved. The Clang Area Team secretary will proactively look for
157+
RFCs that appear to not have a clear path forward to add them to the team's
158+
agenda. If anyone would like to put an RFC onto the team's agenda explicitly,
159+
they can tag any one of the <a href="https://github.com/llvm/llvm-project/blob/main/clang/AreaTeamMembers.txt">
160+
Clang Area Team</a> members in a comment on the RFC to get their attention. The
161+
area team will host a meeting to discuss the RFC and determine next steps for
162+
the proposal. In the event no clear community consensus position seems likely
163+
to ever form, the Clang Area Team will make a final judgement call on whether
164+
the RFC will proceed or not. <!-- TODO: link to area team processes -->
165+
</p>
137166
</div>
138167
</body>
139168
</html>

0 commit comments

Comments
 (0)