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     -
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
219
220Office hours
221------------
222
223A number of experienced LLVM contributors make themselves available for a chat
224on a regular schedule, to anyone who is looking for some guidance. Please find
225the list of who is available when, through which medium, and what their area of
226expertise is. Don't be too shy to dial in!
227
228Of course, people take time off from time to time, so if you dial in and you
229don't find anyone present, chances are they happen to be off that day.
230
231.. list-table:: LLVM office hours
232  :widths: 15 40 15 15 15
233  :header-rows: 1
234
235  * - Name
236    - In-scope topics
237    - When?
238    - Where?
239    - Languages
240  * - Kristof Beyls
241    - General questions on how to contribute to LLVM; organizing meetups;
242      submitting talks; and other general LLVM-related topics. Arm/AArch64
243      codegen.
244    - Every 2nd and 4th Wednesday of the month at 9.30am CET, for 30 minutes.
245      `ics <https://calendar.google.com/calendar/ical/co0h4ndpvtfe64opn7eraiq3ac%40group.calendar.google.com/public/basic.ics>`__
246    - `Jitsi <https://meet.jit.si/KristofBeylsLLVMOfficeHour>`__
247    - English, Flemish, Dutch
248  * - Alina Sbirlea
249    - General questions on how to contribute to LLVM; women in compilers;
250      MemorySSA, BatchAA, various loop passes, new pass manager.
251    - Monthly, 2nd Tuesdays, 10.00am PT/7:00pm CET, for 30 minutes.
252      `ics <https://calendar.google.com/calendar/ical/c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com/public/basic.ics>`__
253      `gcal <https://calendar.google.com/calendar/embed?src=c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com>`__
254    - `GoogleMeet <https://meet.google.com/hhk-xpdj-gvx>`__
255    - English, Romanian
256  * - Aaron Ballman
257    - Clang internals; frontend attributes; clang-tidy; clang-query; AST matchers
258    - Monthly, 2nd Monday of the month at 10:00am Eastern, for 30 minutes.
259      `ics <https://calendar.google.com/calendar/ical/npgke5dug0uliud0qapptmps58%40group.calendar.google.com/public/basic.ics>`__
260      `gcal <https://calendar.google.com/calendar/embed?src=npgke5dug0uliud0qapptmps58%40group.calendar.google.com>`__
261    - `GoogleMeet <https://meet.google.com/xok-iqne-gmi>`__
262    - English, Norwegian (not fluently)
263
264
265IRC
266---
267
268Users and developers of the LLVM project (including subprojects such as Clang)
269can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
270
271This channel has several bots.
272
273* Buildbot reporters
274
275  * llvmbb - Bot for the main LLVM buildbot master.
276    http://lab.llvm.org/buildbot/#/console
277
278* robot - Bugzilla linker. %bug <number>
279
280* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
281  near-trunk clang instead of gcc.
282
283In addition to the traditional IRC there is a
284`Discord <https://discord.com/channels/636084430946959380/636725486533345280>`_
285chat server available. To sign up, please use this
286`invitation link <https://discord.com/invite/xS7Z362>`_.
287
288
289.. _meetups-social-events:
290
291Meetups and social events
292-------------------------
293
294.. toctree::
295   :hidden:
296
297   MeetupGuidelines
298
299Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,
300there are several user groups called
301`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to
302join one in your city. Or start a new one if there is none:
303
304:doc:`MeetupGuidelines`
305
306.. _community-proposals:
307
308Community wide proposals
309------------------------
310
311Proposals for massive changes in how the community behaves and how the work flow
312can be better.
313
314.. toctree::
315   :hidden:
316
317   CodeOfConduct
318   Proposals/GitHubMove
319   BugpointRedesign
320   Proposals/TestSuite
321   Proposals/VariableNames
322   Proposals/VectorizationPlan
323   Proposals/VectorPredication
324
325:doc:`CodeOfConduct`
326   Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
327   IRC, etc).
328
329:doc:`Proposals/GitHubMove`
330   Proposal to move from SVN/Git to GitHub.
331
332:doc:`BugpointRedesign`
333   Design doc for a redesign of the Bugpoint tool.
334
335:doc:`Proposals/TestSuite`
336   Proposals for additional benchmarks/programs for llvm's test-suite.
337
338:doc:`Proposals/VariableNames`
339   Proposal to change the variable names coding standard.
340
341:doc:`Proposals/VectorizationPlan`
342   Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
343
344:doc:`Proposals/VectorPredication`
345   Proposal for predicated vector instructions in LLVM.
346