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   SphinxQuickstartTemplate
16   Phabricator
17   HowToSubmitABug
18   BugLifeCycle
19   CodingStandards
20   GitBisecting
21
22:doc:`Contributing`
23   An overview on how to contribute to LLVM.
24
25:doc:`DeveloperPolicy`
26   The LLVM project's policy towards developers and their contributions.
27
28:doc:`CodeReview`
29   The LLVM project's code-review process.
30
31:doc:`SphinxQuickstartTemplate`
32  A template + tutorial for writing new Sphinx documentation. It is meant
33  to be read in source form.
34
35:doc:`Phabricator`
36   Describes how to use the Phabricator code review tool hosted on
37   http://reviews.llvm.org/ and its command line interface, Arcanist.
38
39:doc:`HowToSubmitABug`
40   Instructions for properly submitting information about any bugs you run into
41   in the LLVM system.
42
43:doc:`BugLifeCycle`
44   Describes how bugs are reported, triaged and closed.
45
46:doc:`CodingStandards`
47  Details the LLVM coding standards and provides useful information on writing
48  efficient C++ code.
49
50:doc:`GitBisecting`
51  Describes how to use ``git bisect`` on LLVM's repository.
52
53.. _development-process:
54
55Development Process
56-------------------
57
58Information about LLVM's development process.
59
60.. toctree::
61   :hidden:
62
63   Projects
64   LLVMBuild
65   HowToReleaseLLVM
66   Packaging
67   ReleaseProcess
68   HowToAddABuilder
69   ReleaseNotes
70
71:doc:`Projects`
72  How-to guide and templates for new projects that *use* the LLVM
73  infrastructure.  The templates (directory organization, Makefiles, and test
74  tree) allow the project code to be located outside (or inside) the ``llvm/``
75  tree, while using LLVM header files and libraries.
76
77:doc:`LLVMBuild`
78  Describes the LLVMBuild organization and files used by LLVM to specify
79  component descriptions.
80
81:doc:`HowToReleaseLLVM`
82  This is a guide to preparing LLVM releases. Most developers can ignore it.
83
84:doc:`ReleaseProcess`
85  This is a guide to validate a new release, during the release process. Most developers can ignore it.
86
87:doc:`HowToAddABuilder`
88   Instructions for adding new builder to LLVM buildbot master.
89
90:doc:`Packaging`
91   Advice on packaging LLVM into a distribution.
92
93:doc:`Release notes for the current release <ReleaseNotes>`
94   This describes new features, known bugs, and other limitations.
95
96.. _mailing-lists:
97
98Mailing Lists
99-------------
100
101If you can't find what you need in these docs, try consulting the mailing
102lists.
103
104`Developer's List (llvm-dev)`__
105  This list is for people who want to be included in technical discussions of
106  LLVM. People post to this list when they have questions about writing code
107  for or using the LLVM tools. It is relatively low volume.
108
109  .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev
110
111`Commits Archive (llvm-commits)`__
112  This list contains all commit messages that are made when LLVM developers
113  commit code changes to the repository. It also serves as a forum for
114  patch review (i.e. send patches here). It is useful for those who want to
115  stay on the bleeding edge of LLVM development. This list is very high
116  volume.
117
118  .. __: http://lists.llvm.org/pipermail/llvm-commits/
119
120`Bugs & Patches Archive (llvm-bugs)`__
121  This list gets emailed every time a bug is opened and closed. It is
122  higher volume than the LLVM-dev list.
123
124  .. __: http://lists.llvm.org/pipermail/llvm-bugs/
125
126`Test Results Archive (llvm-testresults)`__
127  A message is automatically sent to this list by every active nightly tester
128  when it completes.  As such, this list gets email several times each day,
129  making it a high volume list.
130
131  .. __: http://lists.llvm.org/pipermail/llvm-testresults/
132
133`LLVM Announcements List (llvm-announce)`__
134  This is a low volume list that provides important announcements regarding
135  LLVM.  It gets email about once a month.
136
137  .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce
138
139IRC
140---
141
142Users and developers of the LLVM project (including subprojects such as Clang)
143can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.
144
145This channel has several bots.
146
147* Buildbot reporters
148
149  * llvmbb - Bot for the main LLVM buildbot master.
150    http://lab.llvm.org:8011/console
151  * smooshlab - Apple's internal buildbot master.
152
153* robot - Bugzilla linker. %bug <number>
154
155* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running
156  near-trunk clang instead of gcc.
157
158.. _meetups-social-events:
159
160Meetups and social events
161-------------------------
162
163.. toctree::
164   :hidden:
165
166   MeetupGuidelines
167
168Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,
169there are several user groups called
170`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to
171join one in your city. Or start a new one if there is none:
172
173:doc:`MeetupGuidelines`
174
175.. _community-proposals:
176
177Community wide proposals
178------------------------
179
180Proposals for massive changes in how the community behaves and how the work flow
181can be better.
182
183.. toctree::
184   :hidden:
185
186   CodeOfConduct
187   Proposals/GitHubMove
188   BugpointRedesign
189   Proposals/LLVMLibC
190   Proposals/TestSuite
191   Proposals/VariableNames
192   Proposals/VectorizationPlan
193   Proposals/VectorPredication
194
195:doc:`CodeOfConduct`
196   Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,
197   IRC, etc).
198
199:doc:`Proposals/GitHubMove`
200   Proposal to move from SVN/Git to GitHub.
201
202:doc:`BugpointRedesign`
203   Design doc for a redesign of the Bugpoint tool.
204
205:doc:`Proposals/LLVMLibC`
206   Proposal to add a libc implementation under the LLVM project.
207
208:doc:`Proposals/TestSuite`
209   Proposals for additional benchmarks/programs for llvm's test-suite.
210
211:doc:`Proposals/VariableNames`
212   Proposal to change the variable names coding standard.
213
214:doc:`Proposals/VectorizationPlan`
215   Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
216
217:doc:`Proposals/VectorPredication`
218   Proposal for predicated vector instructions in LLVM.
219