[clang] [Docs] Explain how to propose an extension in Clang (PR #130803)
Aaron Ballman via cfe-commits
cfe-commits at lists.llvm.org
Tue Mar 11 10:17:13 PDT 2025
https://github.com/AaronBallman updated https://github.com/llvm/llvm-project/pull/130803
>From b7437e58f4c38af4abb3a5c32c1217e6f0d12bed Mon Sep 17 00:00:00 2001
From: Aaron Ballman <aaron at aaronballman.com>
Date: Tue, 11 Mar 2025 13:03:46 -0400
Subject: [PATCH 1/2] [Docs] Explain how to propose an extension in Clang
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.
---
clang/AreaTeamMembers.txt | 13 +++++++++++++
clang/www/get_involved.html | 33 +++++++++++++++++++++++++++++++--
2 files changed, 44 insertions(+), 2 deletions(-)
create mode 100644 clang/AreaTeamMembers.txt
diff --git a/clang/AreaTeamMembers.txt b/clang/AreaTeamMembers.txt
new file mode 100644
index 0000000000000..93d644bef529a
--- /dev/null
+++ b/clang/AreaTeamMembers.txt
@@ -0,0 +1,13 @@
+This is a list of the current Clang Area Team members.
+
+Chair
+-----
+Aaron Ballman <aaron at aaronballman.com>
+
+Secretary
+---------
+Reid Kleckner <rnk at google.com>
+
+Other Members
+-------------
+Eli Friedman <efriedma at quicinc.com>
diff --git a/clang/www/get_involved.html b/clang/www/get_involved.html
index 99fa03abb6234..1939289463f3d 100755
--- a/clang/www/get_involved.html
+++ b/clang/www/get_involved.html
@@ -83,7 +83,7 @@ <h2 id="criteria">Contributing Extensions to Clang</h2>
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
@@ -133,7 +133,36 @@ <h2 id="criteria">Contributing Extensions to Clang</h2>
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>
>From b3e8c3a49f3e1283c7398c9a499cf43c0facfc11 Mon Sep 17 00:00:00 2001
From: Aaron Ballman <aaron at aaronballman.com>
Date: Tue, 11 Mar 2025 13:16:11 -0400
Subject: [PATCH 2/2] Update contact info
This is more similar to how it is presented in the maintainers list and
also gives Discourse, GitHub, and Discord handles in addition to email.
---
clang/AreaTeamMembers.txt | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/clang/AreaTeamMembers.txt b/clang/AreaTeamMembers.txt
index 93d644bef529a..964d11e79f694 100644
--- a/clang/AreaTeamMembers.txt
+++ b/clang/AreaTeamMembers.txt
@@ -2,12 +2,16 @@ This is a list of the current Clang Area Team members.
Chair
-----
-Aaron Ballman <aaron at aaronballman.com>
+Aaron Ballman
+aaron at aaronballman.com (email), AaronBallman (Discourse), AaronBallman (GitHub), AaronBallman (Discord)
Secretary
---------
-Reid Kleckner <rnk at google.com>
+Reid Kleckner
+rnk at google.com (email), rnk (Discourse), rnk (GitHub), rnk (Discord)
Other Members
-------------
-Eli Friedman <efriedma at quicinc.com>
+Eli Friedman
+efriedma at quicinc.com> (email), efriedma-quic (Discourse), efriedma-quic (GitHub)
+
More information about the cfe-commits
mailing list