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   LLVMBuild
69   HowToReleaseLLVM
70   Packaging
71   ReleaseProcess
72   HowToAddABuilder
73   ReleaseNotes
74
75:doc:`Projects`
76  How-to guide and templates for new projects that *use* the LLVM
77  infrastructure.  The templates (directory organization, Makefiles, and test
78  tree) allow the project code to be located outside (or inside) the ``llvm/``
79  tree, while using LLVM header files and libraries.
80
81:doc:`LLVMBuild`
82  Describes the LLVMBuild organization and files used by LLVM to specify
83  component descriptions.
84
85:doc:`HowToReleaseLLVM`
86  This is a guide to preparing LLVM releases. Most developers can ignore it.
87
88:doc:`ReleaseProcess`
89  This is a guide to validate a new release, during the release process. Most developers can ignore it.
90
91:doc:`HowToAddABuilder`
92   Instructions for adding new builder to LLVM buildbot master.
93
94:doc:`Packaging`
95   Advice on packaging LLVM into a distribution.
96
97:doc:`Release notes for the current release <ReleaseNotes>`
98   This describes new features, known bugs, and other limitations.
99
100.. _mailing-lists:
101
102Mailing Lists
103-------------
104
105If you can't find what you need in these docs, try consulting the mailing
106lists.
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
143IRC
144---
145
146Users and developers of the LLVM project (including subprojects such as Clang)
147can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
148
149This channel has several bots.
150
151* Buildbot reporters
152
153  * llvmbb - Bot for the main LLVM buildbot master.
154    http://lab.llvm.org:8011/console
155  * smooshlab - Apple's internal buildbot master.
156
157* robot - Bugzilla linker. %bug <number>
158
159* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
160  near-trunk clang instead of gcc.
161
162.. _meetups-social-events:
163
164Meetups and social events
165-------------------------
166
167.. toctree::
168   :hidden:
169
170   MeetupGuidelines
171
172Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,
173there are several user groups called
174`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to
175join one in your city. Or start a new one if there is none:
176
177:doc:`MeetupGuidelines`
178
179.. _community-proposals:
180
181Community wide proposals
182------------------------
183
184Proposals for massive changes in how the community behaves and how the work flow
185can be better.
186
187.. toctree::
188   :hidden:
189
190   CodeOfConduct
191   Proposals/GitHubMove
192   BugpointRedesign
193   Proposals/LLVMLibC
194   Proposals/TestSuite
195   Proposals/VariableNames
196   Proposals/VectorizationPlan
197   Proposals/VectorPredication
198
199:doc:`CodeOfConduct`
200   Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
201   IRC, etc).
202
203:doc:`Proposals/GitHubMove`
204   Proposal to move from SVN/Git to GitHub.
205
206:doc:`BugpointRedesign`
207   Design doc for a redesign of the Bugpoint tool.
208
209:doc:`Proposals/LLVMLibC`
210   Proposal to add a libc implementation under the LLVM project.
211
212:doc:`Proposals/TestSuite`
213   Proposals for additional benchmarks/programs for llvm's test-suite.
214
215:doc:`Proposals/VariableNames`
216   Proposal to change the variable names coding standard.
217
218:doc:`Proposals/VectorizationPlan`
219   Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
220
221:doc:`Proposals/VectorPredication`
222   Proposal for predicated vector instructions in LLVM.
223