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   GitHub
22   GitBisecting
23   GitRepositoryPolicy
24
25:doc:`Contributing`
26   An overview on how to contribute to LLVM.
27
28:doc:`DeveloperPolicy`
29   The LLVM project's policy towards developers and their contributions.
30
31:doc:`CodeReview`
32   The LLVM project's code-review process.
33
34:doc:`SupportPolicy`
35   The LLVM support policy for core and non-core components.
36
37:doc:`SphinxQuickstartTemplate`
38  A template + tutorial for writing new Sphinx documentation. It is meant
39  to be read in source form.
40
41:doc:`Phabricator`
42   Describes how to use the Phabricator code review tool hosted on
43   http://reviews.llvm.org/ and its command line interface, Arcanist.
44
45:doc:`HowToSubmitABug`
46   Instructions for properly submitting information about any bugs you run into
47   in the LLVM system.
48
49:doc:`BugLifeCycle`
50   Describes how bugs are reported, triaged and closed.
51
52:doc:`CodingStandards`
53  Details the LLVM coding standards and provides useful information on writing
54  efficient C++ code.
55
56:doc:`GitHub`
57  Describes how to use the llvm-project repository on GitHub.
58
59:doc:`GitBisecting`
60  Describes how to use ``git bisect`` on LLVM's repository.
61
62:doc:`GitRepositoryPolicy`
63   Collection of policies around the git repositories.
64
65.. _development-process:
66
67Development Process
68-------------------
69
70Information about LLVM's development process.
71
72.. toctree::
73   :hidden:
74
75   Projects
76   HowToReleaseLLVM
77   Packaging
78   ReleaseProcess
79   HowToAddABuilder
80   ReleaseNotes
81
82:doc:`Projects`
83  How-to guide and templates for new projects that *use* the LLVM
84  infrastructure.  The templates (directory organization, Makefiles, and test
85  tree) allow the project code to be located outside (or inside) the ``llvm/``
86  tree, while using LLVM header files and libraries.
87
88:doc:`HowToReleaseLLVM`
89  This is a guide to preparing LLVM releases. Most developers can ignore it.
90
91:doc:`ReleaseProcess`
92  This is a guide to validate a new release, during the release process. Most developers can ignore it.
93
94:doc:`HowToAddABuilder`
95   Instructions for adding new builder to LLVM buildbot master.
96
97:doc:`Packaging`
98   Advice on packaging LLVM into a distribution.
99
100:doc:`Release notes for the current release <ReleaseNotes>`
101   This describes new features, known bugs, and other limitations.
102
103.. _lists-forums:
104
105Forums & Mailing Lists
106----------------------
107
108If you can't find what you need in these docs, try consulting the
109Discourse forums. There are also commit mailing lists for all commits to the LLVM Project.
110The :doc:`CodeOfConduct` applies to all these forums and mailing lists.
111
112`LLVM Discourse`__
113  The forums for all things LLVM and related sub-projects. There are categories and subcategories for a wide variety of areas within LLVM. You can also view tags or search for a specific topic.
114
115  .. __: https://discourse.llvm.org/
116
117`Commits Archive (llvm-commits)`__
118  This list contains all commit messages that are made when LLVM developers
119  commit code changes to the repository. It also serves as a forum for
120  patch review (i.e. send patches here). It is useful for those who want to
121  stay on the bleeding edge of LLVM development. This list is very high
122  volume.
123
124  .. __: http://lists.llvm.org/pipermail/llvm-commits/
125
126`Bugs & Patches Archive (llvm-bugs)`__
127  This list gets emailed every time a bug is opened and closed. It is
128  higher volume than the LLVM-dev list.
129
130  .. __: http://lists.llvm.org/pipermail/llvm-bugs/
131
132`LLVM Announcements`__
133  If you just want project wide announcements such as releases, developers meetings, or blog posts, then you should check out the Announcement category on LLVM Discourse.
134
135  .. __: https://discourse.llvm.org/c/announce/46
136
137.. _online-sync-ups:
138
139Online Sync-Ups
140---------------
141
142A number of regular calls are organized on specific topics. It should be
143expected that the range of topics will change over time. At the time of
144writing, the following sync-ups are organized.
145The :doc:`CodeOfConduct` applies to all online sync-ups.
146
147.. list-table:: LLVM regular sync-up calls
148   :widths: 25 25 25 25
149   :header-rows: 1
150
151   * - Topic
152     - Frequency
153     - Calendar link
154     - Minutes/docs link
155   * - Loop Optimization Working Group
156     - Every 2 weeks on Wednesday
157     - `ics <./_static/LoopOptWG_invite.ics>`__
158     - `Minutes/docs <https://docs.google.com/document/d/1sdzoyB11s0ccTZ3fobqctDpgJmRoFcz0sviKxqczs4g/edit>`__
159   * - RISC-V
160     - Every 2 weeks on Thursday
161     - `ics <https://calendar.google.com/calendar/ical/lowrisc.org_0n5pkesfjcnp0bh5hps1p0bd80%40group.calendar.google.com/public/basic.ics>`__
162       `gcal <https://calendar.google.com/calendar/b/1?cid=bG93cmlzYy5vcmdfMG41cGtlc2ZqY25wMGJoNWhwczFwMGJkODBAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__
163     -
164   * - Scalable Vectors and Arm SVE
165     - Monthly, every 3rd Tuesday
166     - `ics <https://calendar.google.com/calendar/ical/bjms39pe6k6bo5egtsp7don414%40group.calendar.google.com/public/basic.ics>`__
167       `gcal <https://calendar.google.com/calendar/u/0/[email protected]>`__
168     - `Minutes/docs <https://docs.google.com/document/d/1UPH2Hzou5RgGT8XfO39OmVXKEibWPfdYLELSaHr3xzo/edit>`__
169   * - ML Guided Compiler Optimizations
170     - Monthly
171     -
172     - `Minutes/docs <https://docs.google.com/document/d/1JecbplF09l3swTjze-UVeLh4L48svJxGVy4mz_e9Rhs/edit?usp=gmail#heading=h.ts9cmcjbir1j>`__
173   * - `LLVM security group <https://llvm.org/docs/Security.html>`__
174     - Monthly, every 3rd Tuesday
175     - `ics <https://calendar.google.com/calendar/ical/eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com/public/basic.ics>`__
176       `gcal <https://calendar.google.com/calendar/embed?src=eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com>`__
177     - `Minutes/docs <https://discourse.llvm.org/t/llvm-security-group-public-sync-ups/62735>`__
178   * - `CIRCT <https://github.com/llvm/circt>`__
179     - Weekly, on Wednesday
180     -
181     - `Minutes/docs <https://docs.google.com/document/d/1fOSRdyZR2w75D87yU2Ma9h2-_lEPL4NxvhJGJd-s5pk/edit#heading=h.mulvhjtr8dk9>`__
182   * - `MLIR <https://mlir.llvm.org>`__ design meetings
183     - Weekly, on Thursdays
184     -
185     - `Minutes/docs <https://docs.google.com/document/d/1y_9f1AbfgcoVdJh4_aM6-BaSHvrHl8zuA5G4jv_94K8/edit#heading=h.cite1kolful9>`__
186   * - flang
187     - Multiple meeting series, `documented here <https://github.com/llvm/llvm-project/blob/main/flang/docs/GettingInvolved.md#calls>`__
188     -
189     -
190   * - OpenMP
191     - Multiple meeting series, `documented here <https://openmp.llvm.org/docs/SupportAndFAQ.html>`__
192     -
193     -
194   * - LLVM Alias Analysis
195     - Every 4 weeks on Tuesdays
196     - `ics <http://lists.llvm.org/pipermail/llvm-dev/attachments/20201103/a3499a67/attachment-0001.ics>`__
197     - `Minutes/docs <https://docs.google.com/document/d/17U-WvX8qyKc3S36YUKr3xfF-GHunWyYowXbxEdpHscw>`__
198   * - Windows/COFF related developments
199     - Every 2 months on Thursday
200     -
201     - `Minutes/docs <https://docs.google.com/document/d/1A-W0Sas_oHWTEl_x_djZYoRtzAdTONMW_6l1BH9G6Bo/edit?usp=sharing>`__
202   * - Vector Predication
203     - Every 2 weeks on Tuesdays, 3pm UTC
204     -
205     - `Minutes/docs <https://docs.google.com/document/d/1q26ToudQjnqN5x31zk8zgq_s0lem1-BF8pQmciLa4k8/edit?usp=sharing>`__
206   * - LLVM Pointer Authentication
207     - Every month on Mondays
208     - `ics <https://calendar.google.com/calendar/ical/fr1qtmrmt2s9odufjvurkb6j70%40group.calendar.google.com/public/basic.ics>`__
209     - `Minutes/docs <https://discourse.llvm.org/t/llvm-pointer-authentication-sync-ups/62661>`__
210   * - MemorySSA in LLVM
211     - Every 8 weeks on Mondays
212     - `ics <https://calendar.google.com/calendar/ical/c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com/public/basic.ics>`__
213       `gcal <https://calendar.google.com/calendar/embed?src=c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com>`__
214     - `Minutes/docs <https://docs.google.com/document/d/1-uEEZfmRdPThZlctOq9eXlmUaSSAAi8oKxhrPY_lpjk/edit#>`__
215   * - LLVM Embedded Toolchains
216     - Every 4 weeks on Thursdays
217     - `ics <https://drive.google.com/file/d/1uNa-PFYkhAfT83kR2Nc4Fi706TAQFBEL/view?usp=sharing>`__
218       `gcal <https://calendar.google.com/calendar/u/0?cid=ZDQyc3ZlajJmbjIzNG1jaTUybjFsdjA2dWNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__
219     - `Minutes/docs <https://docs.google.com/document/d/1GahxppHJ7o1O_fn1Mbidu1DHEg7V2aOr92LXCtNV1_o/edit?usp=sharing>`__
220   * - Clang C and C++ Language Working Group
221     - 1st and 3rd Wednesday of the month
222     - `gcal <https://calendar.google.com/calendar/u/0?cid=cW1lZGg0ZXNpMnIyZDN2aTVydGVrdWF1YzRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__
223     - `Minutes/docs <https://docs.google.com/document/d/1x5-RbOC6-jnI_NcJ9Dp4pSmGhhNe7lUevuWUIB46TeM/edit?usp=sharing>`__
224
225
226Office hours
227------------
228
229A number of experienced LLVM contributors make themselves available for a chat
230on a regular schedule, to anyone who is looking for some guidance. Please find
231the list of who is available when, through which medium, and what their area of
232expertise is. Don't be too shy to dial in!
233
234The :doc:`CodeOfConduct` applies to all office hours.
235
236Of course, people take time off from time to time, so if you dial in and you
237don't find anyone present, chances are they happen to be off that day.
238
239.. list-table:: LLVM office hours
240  :widths: 15 40 15 15 15
241  :header-rows: 1
242
243  * - Name
244    - In-scope topics
245    - When?
246    - Where?
247    - Languages
248  * - Kristof Beyls
249    - General questions on how to contribute to LLVM; organizing meetups;
250      submitting talks; and other general LLVM-related topics. Arm/AArch64
251      codegen. LLVM security group. LLVM Office Hours.
252    - Every 2nd and 4th Wednesday of the month at 9.30am CET, for 30 minutes.
253      `ics <https://calendar.google.com/calendar/ical/co0h4ndpvtfe64opn7eraiq3ac%40group.calendar.google.com/public/basic.ics>`__
254    - `Jitsi <https://meet.jit.si/KristofBeylsLLVMOfficeHour>`__
255    - English, Flemish, Dutch
256  * - Alina Sbirlea
257    - General questions on how to contribute to LLVM; women in compilers;
258      MemorySSA, BatchAA, various loop passes, new pass manager.
259    - Monthly, 2nd Tuesdays, 10.00am PT/7:00pm CET, for 30 minutes.
260      `ics <https://calendar.google.com/calendar/ical/c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com/public/basic.ics>`__
261      `gcal <https://calendar.google.com/calendar/embed?src=c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com>`__
262    - `GoogleMeet <https://meet.google.com/hhk-xpdj-gvx>`__
263    - English, Romanian
264  * - Aaron Ballman
265    - Clang internals; frontend attributes; clang-tidy; clang-query; AST matchers
266    - Monthly, 2nd Monday of the month at 10:00am Eastern, for 30 minutes.
267      `ics <https://calendar.google.com/calendar/ical/npgke5dug0uliud0qapptmps58%40group.calendar.google.com/public/basic.ics>`__
268      `gcal <https://calendar.google.com/calendar/embed?src=npgke5dug0uliud0qapptmps58%40group.calendar.google.com>`__
269    - `GoogleMeet <https://meet.google.com/xok-iqne-gmi>`__
270    - English, Norwegian (not fluently)
271  * - Johannes Doerfert (he/him)
272    - OpenMP, LLVM-IR, interprocedural optimizations, Attributor, workshops, research, ...
273    - Every 2 weeks, Wednesdays 10:30am (Chicago Time), for 1 hour.
274      `ics <https://outlook.office365.com/owa/calendar/[email protected]/4929bd0f955b4f9b82b7bc995cb3b1bf665030567582422766/S-1-8-2190330107-3188380388-3000953923-1819937831/reachcalendar.ics>`__
275    - `MS Teams <https://teams.microsoft.com/l/meetup-join/19%3ameeting_MTM2ZDNkNGUtZjg3My00ZDFjLTk5NjctYTIwMmI3MWM4MjFj%40thread.v2/0?context=%7b%22Tid%22%3a%220cfca185-25f7-49e3-8ae7-704d5326e285%22%2c%22Oid%22%3a%220cacfb51-1523-4455-a443-adca936d1af0%22%7d>`__
276    - English, German
277  * - Tobias Grosser
278    - General questions on how to contribute to LLVM/MLIR, Polly, Loop Optimization, FPL, Research in LLVM, PhD in CS, Summer of Code.
279    - Monthly, last Monday of the month at 18:00 London time (typically 9am PT), for 30 minutes.
280    - `Video Call <https://meet.grosser.science/LLVMOfficeHours>`__
281    - English, German, Spanish, French
282  * - Anastasia Stulova
283    - Clang internals for C/C++ language extensions and dialects, OpenCL, GPU, SPIR-V, how to contribute, women in compilers.
284    - Monthly, 2nd Thursday of the month at 17:00 BST - London time (9:00am PT except for 2 weeks in spring), 1 hour slot.
285    - `GoogleMeet <https://meet.google.com/kdy-fdbv-nuk>`__
286    - English, Russian, German (not fluently)
287
288
289Guidance for office hours hosts
290^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
291
292* If you're interested in becoming an office hours host, please add your
293  information to the list above.
294* When starting an office hours session, consider typing something like "*Hi,
295  I'm available for chats in the next half hour at* video chat URL. *I'm
296  looking forward to having conversations on the video chat or here.*" on the
297  LLVM chat channels that you are already on. These could include:
298
299    * the `#office-hours Discord channel
300      <https://discord.com/channels/636084430946959380/976196303681896538>`__.
301    * :ref:`IRC`
302
303  Doing this can help:
304    * overcome potential anxiety to call in for a first time,
305    * people who prefer to first exchange a few messages through text chat
306      before dialing in, and
307    * remind the wider community that office hours do exist.
308* If you decide to no longer host office hours, please do remove your entry
309  from the list above.
310
311
312.. _IRC:
313
314IRC
315---
316
317Users and developers of the LLVM project (including subprojects such as Clang)
318can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
319
320This channel has several bots.
321
322* Buildbot reporters
323
324  * llvmbb - Bot for the main LLVM buildbot master.
325    http://lab.llvm.org/buildbot/#/console
326
327* robot - Bugzilla linker. %bug <number>
328
329* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
330  near-trunk clang instead of gcc.
331
332In addition to the traditional IRC there is a
333`Discord <https://discord.com/channels/636084430946959380/636725486533345280>`_
334chat server available. To sign up, please use this
335`invitation link <https://discord.com/invite/xS7Z362>`_.
336
337
338.. _meetups-social-events:
339
340Meetups and social events
341-------------------------
342
343.. toctree::
344   :hidden:
345
346   MeetupGuidelines
347
348Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,
349there are several user groups called
350`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to
351join one in your city. Or start a new one if there is none:
352
353:doc:`MeetupGuidelines`
354
355.. _community-proposals:
356
357Community wide proposals
358------------------------
359
360Proposals for massive changes in how the community behaves and how the work flow
361can be better.
362
363.. toctree::
364   :hidden:
365
366   Proposals/GitHubMove
367   BugpointRedesign
368   Proposals/TestSuite
369   Proposals/VariableNames
370   Proposals/VectorizationPlan
371   Proposals/VectorPredication
372
373:doc:`Proposals/GitHubMove`
374   Proposal to move from SVN/Git to GitHub.
375
376:doc:`BugpointRedesign`
377   Design doc for a redesign of the Bugpoint tool.
378
379:doc:`Proposals/TestSuite`
380   Proposals for additional benchmarks/programs for llvm's test-suite.
381
382:doc:`Proposals/VariableNames`
383   Proposal to change the variable names coding standard.
384
385:doc:`Proposals/VectorizationPlan`
386   Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
387
388:doc:`Proposals/VectorPredication`
389   Proposal for predicated vector instructions in LLVM.
390