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