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.
102
103`Developer's List (llvm-dev)`__
104  This list is for people who want to be included in technical discussions of
105  LLVM. People post to this list when they have questions about writing code
106  for or using the LLVM tools. It is relatively low volume.
107
108  .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
109
110`Commits Archive (llvm-commits)`__
111  This list contains all commit messages that are made when LLVM developers
112  commit code changes to the repository. It also serves as a forum for
113  patch review (i.e. send patches here). It is useful for those who want to
114  stay on the bleeding edge of LLVM development. This list is very high
115  volume.
116
117  .. __: http://lists.llvm.org/pipermail/llvm-commits/
118
119`Bugs & Patches Archive (llvm-bugs)`__
120  This list gets emailed every time a bug is opened and closed. It is
121  higher volume than the LLVM-dev list.
122
123  .. __: http://lists.llvm.org/pipermail/llvm-bugs/
124
125`Test Results Archive (llvm-testresults)`__
126  A message is automatically sent to this list by every active nightly tester
127  when it completes.  As such, this list gets email several times each day,
128  making it a high volume list.
129
130  .. __: http://lists.llvm.org/pipermail/llvm-testresults/
131
132`LLVM Announcements List (llvm-announce)`__
133  This is a low volume list that provides important announcements regarding
134  LLVM.  It gets email about once a month.
135
136  .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
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   * - RISC-V
154     - Every 2 weeks on Thursday
155     - `ics <https://calendar.google.com/calendar/ical/lowrisc.org_0n5pkesfjcnp0bh5hps1p0bd80%40group.calendar.google.com/public/basic.ics>`__
156       `gcal <https://calendar.google.com/calendar/b/1?cid=bG93cmlzYy5vcmdfMG41cGtlc2ZqY25wMGJoNWhwczFwMGJkODBAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__
157     -
158   * - Scalable Vectors and Arm SVE
159     - Monthly, every 3rd Tuesday
160     - `ics <https://calendar.google.com/calendar/ical/bjms39pe6k6bo5egtsp7don414%40group.calendar.google.com/public/basic.ics>`__
161       `gcal <https://calendar.google.com/calendar/u/0/[email protected]>`__
162     - `Minutes/docs <https://docs.google.com/document/d/1UPH2Hzou5RgGT8XfO39OmVXKEibWPfdYLELSaHr3xzo/edit>`__
163   * - ML Guided Compiler Optimizations
164     - Monthly
165     -
166     - `Minutes/docs <https://docs.google.com/document/d/1JecbplF09l3swTjze-UVeLh4L48svJxGVy4mz_e9Rhs/edit?usp=gmail#heading=h.ts9cmcjbir1j>`__
167   * - `LLVM security group <https://llvm.org/docs/Security.html>`__
168     - Monthly, every 3rd Tuesday
169     - `ics <https://calendar.google.com/calendar/ical/eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com/public/basic.ics>`__
170       `gcal <https://calendar.google.com/calendar/embed?src=eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com>`__
171     - `Minutes/docs <https://docs.google.com/document/d/1GLCE8cl7goCaLSiM9j1eIq5IqeXt6_YTY2UEcC4jmsg/edit?usp=sharing>`__
172   * - `CIRCT <https://github.com/llvm/circt>`__
173     - Weekly, on Wednesday
174     -
175     - `Minutes/docs <https://docs.google.com/document/d/1fOSRdyZR2w75D87yU2Ma9h2-_lEPL4NxvhJGJd-s5pk/edit#heading=h.mulvhjtr8dk9>`__
176   * - `MLIR <https://mlir.llvm.org>`__ design meetings
177     - Weekly, on Thursdays
178     -
179     - `Minutes/docs <https://docs.google.com/document/d/1y_9f1AbfgcoVdJh4_aM6-BaSHvrHl8zuA5G4jv_94K8/edit#heading=h.cite1kolful9>`__
180   * - flang
181     - Multiple meeting series, `documented here <https://github.com/llvm/llvm-project/blob/main/flang/docs/GettingInvolved.md#calls>`__
182     -
183     -
184   * - OpenMP
185     - Multiple meeting series, `documented here <https://openmp.llvm.org/docs/SupportAndFAQ.html>`__
186     -
187     -
188   * - LLVM Alias Analysis
189     - Every 4 weeks on Tuesdays
190     - `ics <http://lists.llvm.org/pipermail/llvm-dev/attachments/20201103/a3499a67/attachment-0001.ics>`__
191     - `Minutes/docs <https://docs.google.com/document/d/17U-WvX8qyKc3S36YUKr3xfF-GHunWyYowXbxEdpHscw>`__
192   * - Windows/COFF related developments
193     - Every 2 months on Thursday
194     -
195     - `Minutes/docs <https://docs.google.com/document/d/1A-W0Sas_oHWTEl_x_djZYoRtzAdTONMW_6l1BH9G6Bo/edit?usp=sharing>`__
196
197
198IRC
199---
200
201Users and developers of the LLVM project (including subprojects such as Clang)
202can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
203
204This channel has several bots.
205
206* Buildbot reporters
207
208  * llvmbb - Bot for the main LLVM buildbot master.
209    http://lab.llvm.org:8011/console
210  * smooshlab - Apple's internal buildbot master.
211
212* robot - Bugzilla linker. %bug <number>
213
214* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
215  near-trunk clang instead of gcc.
216
217.. _meetups-social-events:
218
219Meetups and social events
220-------------------------
221
222.. toctree::
223   :hidden:
224
225   MeetupGuidelines
226
227Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,
228there are several user groups called
229`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to
230join one in your city. Or start a new one if there is none:
231
232:doc:`MeetupGuidelines`
233
234.. _community-proposals:
235
236Community wide proposals
237------------------------
238
239Proposals for massive changes in how the community behaves and how the work flow
240can be better.
241
242.. toctree::
243   :hidden:
244
245   CodeOfConduct
246   Proposals/GitHubMove
247   BugpointRedesign
248   Proposals/LLVMLibC
249   Proposals/TestSuite
250   Proposals/VariableNames
251   Proposals/VectorizationPlan
252   Proposals/VectorPredication
253
254:doc:`CodeOfConduct`
255   Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
256   IRC, etc).
257
258:doc:`Proposals/GitHubMove`
259   Proposal to move from SVN/Git to GitHub.
260
261:doc:`BugpointRedesign`
262   Design doc for a redesign of the Bugpoint tool.
263
264:doc:`Proposals/LLVMLibC`
265   Proposal to add a libc implementation under the LLVM project.
266
267:doc:`Proposals/TestSuite`
268   Proposals for additional benchmarks/programs for llvm's test-suite.
269
270:doc:`Proposals/VariableNames`
271   Proposal to change the variable names coding standard.
272
273:doc:`Proposals/VectorizationPlan`
274   Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
275
276:doc:`Proposals/VectorPredication`
277   Proposal for predicated vector instructions in LLVM.
278