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