1Getting Involved
2================
3
4LLVM welcomes contributions of all kinds. To get started, please review the following topics:
5
6.. contents::
7   :local:
8
9.. toctree::
10   :hidden:
11
12   Contributing
13   DeveloperPolicy
14   CodeReview
15   SupportPolicy
16   SphinxQuickstartTemplate
17   Phabricator
18   HowToSubmitABug
19   BugLifeCycle
20   CodingStandards
21   GitBisecting
22
23:doc:`Contributing`
24   An overview on how to contribute to LLVM.
25
26:doc:`DeveloperPolicy`
27   The LLVM project's policy towards developers and their contributions.
28
29:doc:`CodeReview`
30   The LLVM project's code-review process.
31
32:doc:`SupportPolicy`
33   The LLVM support policy for core and non-core components.
34
35:doc:`SphinxQuickstartTemplate`
36  A template + tutorial for writing new Sphinx documentation. It is meant
37  to be read in source form.
38
39:doc:`Phabricator`
40   Describes how to use the Phabricator code review tool hosted on
41   http://reviews.llvm.org/ and its command line interface, Arcanist.
42
43:doc:`HowToSubmitABug`
44   Instructions for properly submitting information about any bugs you run into
45   in the LLVM system.
46
47:doc:`BugLifeCycle`
48   Describes how bugs are reported, triaged and closed.
49
50:doc:`CodingStandards`
51  Details the LLVM coding standards and provides useful information on writing
52  efficient C++ code.
53
54:doc:`GitBisecting`
55  Describes how to use ``git bisect`` on LLVM's repository.
56
57.. _development-process:
58
59Development Process
60-------------------
61
62Information about LLVM's development process.
63
64.. toctree::
65   :hidden:
66
67   Projects
68   HowToReleaseLLVM
69   Packaging
70   ReleaseProcess
71   HowToAddABuilder
72   ReleaseNotes
73
74:doc:`Projects`
75  How-to guide and templates for new projects that *use* the LLVM
76  infrastructure.  The templates (directory organization, Makefiles, and test
77  tree) allow the project code to be located outside (or inside) the ``llvm/``
78  tree, while using LLVM header files and libraries.
79
80:doc:`HowToReleaseLLVM`
81  This is a guide to preparing LLVM releases. Most developers can ignore it.
82
83:doc:`ReleaseProcess`
84  This is a guide to validate a new release, during the release process. Most developers can ignore it.
85
86:doc:`HowToAddABuilder`
87   Instructions for adding new builder to LLVM buildbot master.
88
89:doc:`Packaging`
90   Advice on packaging LLVM into a distribution.
91
92:doc:`Release notes for the current release <ReleaseNotes>`
93   This describes new features, known bugs, and other limitations.
94
95.. _mailing-lists:
96
97Mailing Lists
98-------------
99
100If you can't find what you need in these docs, try consulting the mailing
101lists. In addition to the traditional mailing lists there is also a
102`Discourse server <https://llvm.discourse.group>`_ available.
103
104`Developer's List (llvm-dev)`__
105  This list is for people who want to be included in technical discussions of
106  LLVM. People post to this list when they have questions about writing code
107  for or using the LLVM tools. It is relatively low volume.
108
109  .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
110
111`Commits Archive (llvm-commits)`__
112  This list contains all commit messages that are made when LLVM developers
113  commit code changes to the repository. It also serves as a forum for
114  patch review (i.e. send patches here). It is useful for those who want to
115  stay on the bleeding edge of LLVM development. This list is very high
116  volume.
117
118  .. __: http://lists.llvm.org/pipermail/llvm-commits/
119
120`Bugs & Patches Archive (llvm-bugs)`__
121  This list gets emailed every time a bug is opened and closed. It is
122  higher volume than the LLVM-dev list.
123
124  .. __: http://lists.llvm.org/pipermail/llvm-bugs/
125
126`Test Results Archive (llvm-testresults)`__
127  A message is automatically sent to this list by every active nightly tester
128  when it completes.  As such, this list gets email several times each day,
129  making it a high volume list.
130
131  .. __: http://lists.llvm.org/pipermail/llvm-testresults/
132
133`LLVM Announcements List (llvm-announce)`__
134  This is a low volume list that provides important announcements regarding
135  LLVM.  It gets email about once a month.
136
137  .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
138
139.. _online-sync-ups:
140
141Online Sync-Ups
142---------------
143
144A number of regular calls are organized on specific topics. It should be
145expected that the range of topics will change over time. At the time of
146writing, the following sync-ups are organized:
147
148.. list-table:: LLVM regular sync-up calls
149   :widths: 25 25 25 25
150   :header-rows: 1
151
152   * - Topic
153     - Frequency
154     - Calendar link
155     - Minutes/docs link
156   * - RISC-V
157     - Every 2 weeks on Thursday
158     - `ics <https://calendar.google.com/calendar/ical/lowrisc.org_0n5pkesfjcnp0bh5hps1p0bd80%40group.calendar.google.com/public/basic.ics>`__
159       `gcal <https://calendar.google.com/calendar/b/1?cid=bG93cmlzYy5vcmdfMG41cGtlc2ZqY25wMGJoNWhwczFwMGJkODBAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__
160     -
161   * - Scalable Vectors and Arm SVE
162     - Monthly, every 3rd Tuesday
163     - `ics <https://calendar.google.com/calendar/ical/bjms39pe6k6bo5egtsp7don414%40group.calendar.google.com/public/basic.ics>`__
164       `gcal <https://calendar.google.com/calendar/u/0/[email protected]>`__
165     - `Minutes/docs <https://docs.google.com/document/d/1UPH2Hzou5RgGT8XfO39OmVXKEibWPfdYLELSaHr3xzo/edit>`__
166   * - ML Guided Compiler Optimizations
167     - Monthly
168     -
169     - `Minutes/docs <https://docs.google.com/document/d/1JecbplF09l3swTjze-UVeLh4L48svJxGVy4mz_e9Rhs/edit?usp=gmail#heading=h.ts9cmcjbir1j>`__
170   * - `LLVM security group <https://llvm.org/docs/Security.html>`__
171     - Monthly, every 3rd Tuesday
172     - `ics <https://calendar.google.com/calendar/ical/eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com/public/basic.ics>`__
173       `gcal <https://calendar.google.com/calendar/embed?src=eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com>`__
174     - `Minutes/docs <https://docs.google.com/document/d/1GLCE8cl7goCaLSiM9j1eIq5IqeXt6_YTY2UEcC4jmsg/edit?usp=sharing>`__
175   * - `CIRCT <https://github.com/llvm/circt>`__
176     - Weekly, on Wednesday
177     -
178     - `Minutes/docs <https://docs.google.com/document/d/1fOSRdyZR2w75D87yU2Ma9h2-_lEPL4NxvhJGJd-s5pk/edit#heading=h.mulvhjtr8dk9>`__
179   * - `MLIR <https://mlir.llvm.org>`__ design meetings
180     - Weekly, on Thursdays
181     -
182     - `Minutes/docs <https://docs.google.com/document/d/1y_9f1AbfgcoVdJh4_aM6-BaSHvrHl8zuA5G4jv_94K8/edit#heading=h.cite1kolful9>`__
183   * - flang
184     - Multiple meeting series, `documented here <https://github.com/llvm/llvm-project/blob/main/flang/docs/GettingInvolved.md#calls>`__
185     -
186     -
187   * - OpenMP
188     - Multiple meeting series, `documented here <https://openmp.llvm.org/docs/SupportAndFAQ.html>`__
189     -
190     -
191   * - LLVM Alias Analysis
192     - Every 4 weeks on Tuesdays
193     - `ics <http://lists.llvm.org/pipermail/llvm-dev/attachments/20201103/a3499a67/attachment-0001.ics>`__
194     - `Minutes/docs <https://docs.google.com/document/d/17U-WvX8qyKc3S36YUKr3xfF-GHunWyYowXbxEdpHscw>`__
195   * - Windows/COFF related developments
196     - Every 2 months on Thursday
197     -
198     - `Minutes/docs <https://docs.google.com/document/d/1A-W0Sas_oHWTEl_x_djZYoRtzAdTONMW_6l1BH9G6Bo/edit?usp=sharing>`__
199   * - Vector Predication
200     - Every 2 weeks on Tuesdays, 3pm UTC
201     -
202     - `Minutes/docs <https://docs.google.com/document/d/1q26ToudQjnqN5x31zk8zgq_s0lem1-BF8pQmciLa4k8/edit?usp=sharing>`__
203   * - LLVM Pointer Authentication
204     - Every month on Mondays
205     - `ics <https://calendar.google.com/calendar/ical/fr1qtmrmt2s9odufjvurkb6j70%40group.calendar.google.com/public/basic.ics>`__
206     - `Minutes/docs <https://docs.google.com/document/d/14IDnh3YY9m6Ej_PaRKOz8tTTZlObgtLl8mYeRbytAec/edit?usp=sharing>`__
207   * - MemorySSA in LLVM
208     - Every 8 weeks on Mondays
209     - `ics <https://calendar.google.com/calendar/ical/c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com/public/basic.ics>`__
210       `gcal <https://calendar.google.com/calendar/embed?src=c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com>`__
211     - `Minutes/docs <https://docs.google.com/document/d/1-uEEZfmRdPThZlctOq9eXlmUaSSAAi8oKxhrPY_lpjk/edit#>`__
212
213IRC
214---
215
216Users and developers of the LLVM project (including subprojects such as Clang)
217can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
218
219This channel has several bots.
220
221* Buildbot reporters
222
223  * llvmbb - Bot for the main LLVM buildbot master.
224    http://lab.llvm.org:8011/console
225  * smooshlab - Apple's internal buildbot master.
226
227* robot - Bugzilla linker. %bug <number>
228
229* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
230  near-trunk clang instead of gcc.
231
232In addition to the traditional IRC there is a
233`Discord <https://discord.com/channels/636084430946959380/636725486533345280>`_
234chat server available. To sign up, please use this
235`invitation link <https://discord.com/invite/xS7Z362>`_.
236
237
238.. _meetups-social-events:
239
240Meetups and social events
241-------------------------
242
243.. toctree::
244   :hidden:
245
246   MeetupGuidelines
247
248Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,
249there are several user groups called
250`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to
251join one in your city. Or start a new one if there is none:
252
253:doc:`MeetupGuidelines`
254
255.. _community-proposals:
256
257Community wide proposals
258------------------------
259
260Proposals for massive changes in how the community behaves and how the work flow
261can be better.
262
263.. toctree::
264   :hidden:
265
266   CodeOfConduct
267   Proposals/GitHubMove
268   BugpointRedesign
269   Proposals/LLVMLibC
270   Proposals/TestSuite
271   Proposals/VariableNames
272   Proposals/VectorizationPlan
273   Proposals/VectorPredication
274
275:doc:`CodeOfConduct`
276   Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
277   IRC, etc).
278
279:doc:`Proposals/GitHubMove`
280   Proposal to move from SVN/Git to GitHub.
281
282:doc:`BugpointRedesign`
283   Design doc for a redesign of the Bugpoint tool.
284
285:doc:`Proposals/LLVMLibC`
286   Proposal to add a libc implementation under the LLVM project.
287
288:doc:`Proposals/TestSuite`
289   Proposals for additional benchmarks/programs for llvm's test-suite.
290
291:doc:`Proposals/VariableNames`
292   Proposal to change the variable names coding standard.
293
294:doc:`Proposals/VectorizationPlan`
295   Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
296
297:doc:`Proposals/VectorPredication`
298   Proposal for predicated vector instructions in LLVM.
299