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