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.
110
111`LLVM Discourse`__
112  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.
113
114  .. __: https://discourse.llvm.org/
115
116`Commits Archive (llvm-commits)`__
117  This list contains all commit messages that are made when LLVM developers
118  commit code changes to the repository. It also serves as a forum for
119  patch review (i.e. send patches here). It is useful for those who want to
120  stay on the bleeding edge of LLVM development. This list is very high
121  volume.
122
123  .. __: http://lists.llvm.org/pipermail/llvm-commits/
124
125`Bugs & Patches Archive (llvm-bugs)`__
126  This list gets emailed every time a bug is opened and closed. It is
127  higher volume than the LLVM-dev list.
128
129  .. __: http://lists.llvm.org/pipermail/llvm-bugs/
130
131`LLVM Announcements`__
132  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.
133
134  .. __: https://discourse.llvm.org/c/announce/46
135
136.. _online-sync-ups:
137
138Online Sync-Ups
139---------------
140
141A number of regular calls are organized on specific topics. It should be
142expected that the range of topics will change over time. At the time of
143writing, the following sync-ups are organized:
144
145.. list-table:: LLVM regular sync-up calls
146   :widths: 25 25 25 25
147   :header-rows: 1
148
149   * - Topic
150     - Frequency
151     - Calendar link
152     - Minutes/docs link
153   * - Loop Optimization Working Group
154     - Every 2 weeks on Wednesday
155     - `ics <./_static/LoopOptWG_invite.ics>`__
156     - `Minutes/docs <https://docs.google.com/document/d/1sdzoyB11s0ccTZ3fobqctDpgJmRoFcz0sviKxqczs4g/edit>`__
157   * - RISC-V
158     - Every 2 weeks on Thursday
159     - `ics <https://calendar.google.com/calendar/ical/lowrisc.org_0n5pkesfjcnp0bh5hps1p0bd80%40group.calendar.google.com/public/basic.ics>`__
160       `gcal <https://calendar.google.com/calendar/b/1?cid=bG93cmlzYy5vcmdfMG41cGtlc2ZqY25wMGJoNWhwczFwMGJkODBAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__
161     -
162   * - Scalable Vectors and Arm SVE
163     - Monthly, every 3rd Tuesday
164     - `ics <https://calendar.google.com/calendar/ical/bjms39pe6k6bo5egtsp7don414%40group.calendar.google.com/public/basic.ics>`__
165       `gcal <https://calendar.google.com/calendar/u/0/[email protected]>`__
166     - `Minutes/docs <https://docs.google.com/document/d/1UPH2Hzou5RgGT8XfO39OmVXKEibWPfdYLELSaHr3xzo/edit>`__
167   * - ML Guided Compiler Optimizations
168     - Monthly
169     -
170     - `Minutes/docs <https://docs.google.com/document/d/1JecbplF09l3swTjze-UVeLh4L48svJxGVy4mz_e9Rhs/edit?usp=gmail#heading=h.ts9cmcjbir1j>`__
171   * - `LLVM security group <https://llvm.org/docs/Security.html>`__
172     - Monthly, every 3rd Tuesday
173     - `ics <https://calendar.google.com/calendar/ical/eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com/public/basic.ics>`__
174       `gcal <https://calendar.google.com/calendar/embed?src=eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com>`__
175     - `Minutes/docs <https://docs.google.com/document/d/1GLCE8cl7goCaLSiM9j1eIq5IqeXt6_YTY2UEcC4jmsg/edit?usp=sharing>`__
176   * - `CIRCT <https://github.com/llvm/circt>`__
177     - Weekly, on Wednesday
178     -
179     - `Minutes/docs <https://docs.google.com/document/d/1fOSRdyZR2w75D87yU2Ma9h2-_lEPL4NxvhJGJd-s5pk/edit#heading=h.mulvhjtr8dk9>`__
180   * - `MLIR <https://mlir.llvm.org>`__ design meetings
181     - Weekly, on Thursdays
182     -
183     - `Minutes/docs <https://docs.google.com/document/d/1y_9f1AbfgcoVdJh4_aM6-BaSHvrHl8zuA5G4jv_94K8/edit#heading=h.cite1kolful9>`__
184   * - flang
185     - Multiple meeting series, `documented here <https://github.com/llvm/llvm-project/blob/main/flang/docs/GettingInvolved.md#calls>`__
186     -
187     -
188   * - OpenMP
189     - Multiple meeting series, `documented here <https://openmp.llvm.org/docs/SupportAndFAQ.html>`__
190     -
191     -
192   * - LLVM Alias Analysis
193     - Every 4 weeks on Tuesdays
194     - `ics <http://lists.llvm.org/pipermail/llvm-dev/attachments/20201103/a3499a67/attachment-0001.ics>`__
195     - `Minutes/docs <https://docs.google.com/document/d/17U-WvX8qyKc3S36YUKr3xfF-GHunWyYowXbxEdpHscw>`__
196   * - Windows/COFF related developments
197     - Every 2 months on Thursday
198     -
199     - `Minutes/docs <https://docs.google.com/document/d/1A-W0Sas_oHWTEl_x_djZYoRtzAdTONMW_6l1BH9G6Bo/edit?usp=sharing>`__
200   * - Vector Predication
201     - Every 2 weeks on Tuesdays, 3pm UTC
202     -
203     - `Minutes/docs <https://docs.google.com/document/d/1q26ToudQjnqN5x31zk8zgq_s0lem1-BF8pQmciLa4k8/edit?usp=sharing>`__
204   * - LLVM Pointer Authentication
205     - Every month on Mondays
206     - `ics <https://calendar.google.com/calendar/ical/fr1qtmrmt2s9odufjvurkb6j70%40group.calendar.google.com/public/basic.ics>`__
207     - `Minutes/docs <https://docs.google.com/document/d/14IDnh3YY9m6Ej_PaRKOz8tTTZlObgtLl8mYeRbytAec/edit?usp=sharing>`__
208   * - MemorySSA in LLVM
209     - Every 8 weeks on Mondays
210     - `ics <https://calendar.google.com/calendar/ical/c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com/public/basic.ics>`__
211       `gcal <https://calendar.google.com/calendar/embed?src=c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com>`__
212     - `Minutes/docs <https://docs.google.com/document/d/1-uEEZfmRdPThZlctOq9eXlmUaSSAAi8oKxhrPY_lpjk/edit#>`__
213   * - LLVM Embedded Toolchains
214     - Every 4 weeks on Thursdays
215     - `ics <https://drive.google.com/file/d/1uNa-PFYkhAfT83kR2Nc4Fi706TAQFBEL/view?usp=sharing>`__
216       `gcal <https://calendar.google.com/calendar/u/0?cid=ZDQyc3ZlajJmbjIzNG1jaTUybjFsdjA2dWNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__
217     - `Minutes/docs <https://docs.google.com/document/d/1GahxppHJ7o1O_fn1Mbidu1DHEg7V2aOr92LXCtNV1_o/edit?usp=sharing>`__
218   * - Clang C and C++ Language Working Group
219     - 1st and 3rd Wednesday of the month
220     - `gcal <https://calendar.google.com/calendar/u/0?cid=cW1lZGg0ZXNpMnIyZDN2aTVydGVrdWF1YzRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__
221     - `Minutes/docs <https://docs.google.com/document/d/1x5-RbOC6-jnI_NcJ9Dp4pSmGhhNe7lUevuWUIB46TeM/edit?usp=sharing>`__
222
223
224Office hours
225------------
226
227A number of experienced LLVM contributors make themselves available for a chat
228on a regular schedule, to anyone who is looking for some guidance. Please find
229the list of who is available when, through which medium, and what their area of
230expertise is. Don't be too shy to dial in!
231
232Of course, people take time off from time to time, so if you dial in and you
233don't find anyone present, chances are they happen to be off that day.
234
235.. list-table:: LLVM office hours
236  :widths: 15 40 15 15 15
237  :header-rows: 1
238
239  * - Name
240    - In-scope topics
241    - When?
242    - Where?
243    - Languages
244  * - Kristof Beyls
245    - General questions on how to contribute to LLVM; organizing meetups;
246      submitting talks; and other general LLVM-related topics. Arm/AArch64
247      codegen. LLVM security group.
248    - Every 2nd and 4th Wednesday of the month at 9.30am CET, for 30 minutes.
249      `ics <https://calendar.google.com/calendar/ical/co0h4ndpvtfe64opn7eraiq3ac%40group.calendar.google.com/public/basic.ics>`__
250    - `Jitsi <https://meet.jit.si/KristofBeylsLLVMOfficeHour>`__
251    - English, Flemish, Dutch
252  * - Alina Sbirlea
253    - General questions on how to contribute to LLVM; women in compilers;
254      MemorySSA, BatchAA, various loop passes, new pass manager.
255    - Monthly, 2nd Tuesdays, 10.00am PT/7:00pm CET, for 30 minutes.
256      `ics <https://calendar.google.com/calendar/ical/c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com/public/basic.ics>`__
257      `gcal <https://calendar.google.com/calendar/embed?src=c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com>`__
258    - `GoogleMeet <https://meet.google.com/hhk-xpdj-gvx>`__
259    - English, Romanian
260  * - Aaron Ballman
261    - Clang internals; frontend attributes; clang-tidy; clang-query; AST matchers
262    - Monthly, 2nd Monday of the month at 10:00am Eastern, for 30 minutes.
263      `ics <https://calendar.google.com/calendar/ical/npgke5dug0uliud0qapptmps58%40group.calendar.google.com/public/basic.ics>`__
264      `gcal <https://calendar.google.com/calendar/embed?src=npgke5dug0uliud0qapptmps58%40group.calendar.google.com>`__
265    - `GoogleMeet <https://meet.google.com/xok-iqne-gmi>`__
266    - English, Norwegian (not fluently)
267  * - Johannes Doerfert (he/him)
268    - OpenMP, LLVM-IR, interprocedural optimizations, Attributor, workshops, research, ...
269    - Every 2 weeks, Wednesdays 10:30am (Chicago Time), for 1 hour.
270      `ics <https://outlook.office365.com/owa/calendar/[email protected]/4929bd0f955b4f9b82b7bc995cb3b1bf665030567582422766/S-1-8-2190330107-3188380388-3000953923-1819937831/reachcalendar.ics>`__
271    - `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>`__
272    - English, German
273
274IRC
275---
276
277Users and developers of the LLVM project (including subprojects such as Clang)
278can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
279
280This channel has several bots.
281
282* Buildbot reporters
283
284  * llvmbb - Bot for the main LLVM buildbot master.
285    http://lab.llvm.org/buildbot/#/console
286
287* robot - Bugzilla linker. %bug <number>
288
289* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
290  near-trunk clang instead of gcc.
291
292In addition to the traditional IRC there is a
293`Discord <https://discord.com/channels/636084430946959380/636725486533345280>`_
294chat server available. To sign up, please use this
295`invitation link <https://discord.com/invite/xS7Z362>`_.
296
297
298.. _meetups-social-events:
299
300Meetups and social events
301-------------------------
302
303.. toctree::
304   :hidden:
305
306   MeetupGuidelines
307
308Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,
309there are several user groups called
310`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to
311join one in your city. Or start a new one if there is none:
312
313:doc:`MeetupGuidelines`
314
315.. _community-proposals:
316
317Community wide proposals
318------------------------
319
320Proposals for massive changes in how the community behaves and how the work flow
321can be better.
322
323.. toctree::
324   :hidden:
325
326   CodeOfConduct
327   Proposals/GitHubMove
328   BugpointRedesign
329   Proposals/TestSuite
330   Proposals/VariableNames
331   Proposals/VectorizationPlan
332   Proposals/VectorPredication
333
334:doc:`CodeOfConduct`
335   Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
336   IRC, etc).
337
338:doc:`Proposals/GitHubMove`
339   Proposal to move from SVN/Git to GitHub.
340
341:doc:`BugpointRedesign`
342   Design doc for a redesign of the Bugpoint tool.
343
344:doc:`Proposals/TestSuite`
345   Proposals for additional benchmarks/programs for llvm's test-suite.
346
347:doc:`Proposals/VariableNames`
348   Proposal to change the variable names coding standard.
349
350:doc:`Proposals/VectorizationPlan`
351   Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
352
353:doc:`Proposals/VectorPredication`
354   Proposal for predicated vector instructions in LLVM.
355