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 GitHub 22 GitBisecting 23 GitRepositoryPolicy 24 25:doc:`Contributing` 26 An overview on how to contribute to LLVM. 27 28:doc:`DeveloperPolicy` 29 The LLVM project's policy towards developers and their contributions. 30 31:doc:`CodeReview` 32 The LLVM project's code-review process. 33 34:doc:`SupportPolicy` 35 The LLVM support policy for core and non-core components. 36 37:doc:`SphinxQuickstartTemplate` 38 A template + tutorial for writing new Sphinx documentation. It is meant 39 to be read in source form. 40 41:doc:`Phabricator` 42 Describes how to use the Phabricator code review tool hosted on 43 http://reviews.llvm.org/ and its command line interface, Arcanist. 44 45:doc:`HowToSubmitABug` 46 Instructions for properly submitting information about any bugs you run into 47 in the LLVM system. 48 49:doc:`BugLifeCycle` 50 Describes how bugs are reported, triaged and closed. 51 52:doc:`CodingStandards` 53 Details the LLVM coding standards and provides useful information on writing 54 efficient C++ code. 55 56:doc:`GitHub` 57 Describes how to use the llvm-project repository on GitHub. 58 59:doc:`GitBisecting` 60 Describes how to use ``git bisect`` on LLVM's repository. 61 62:doc:`GitRepositoryPolicy` 63 Collection of policies around the git repositories. 64 65.. _development-process: 66 67Development Process 68------------------- 69 70Information about LLVM's development process. 71 72.. toctree:: 73 :hidden: 74 75 Projects 76 HowToReleaseLLVM 77 Packaging 78 ReleaseProcess 79 HowToAddABuilder 80 ReleaseNotes 81 82:doc:`Projects` 83 How-to guide and templates for new projects that *use* the LLVM 84 infrastructure. The templates (directory organization, Makefiles, and test 85 tree) allow the project code to be located outside (or inside) the ``llvm/`` 86 tree, while using LLVM header files and libraries. 87 88:doc:`HowToReleaseLLVM` 89 This is a guide to preparing LLVM releases. Most developers can ignore it. 90 91:doc:`ReleaseProcess` 92 This is a guide to validate a new release, during the release process. Most developers can ignore it. 93 94:doc:`HowToAddABuilder` 95 Instructions for adding new builder to LLVM buildbot master. 96 97:doc:`Packaging` 98 Advice on packaging LLVM into a distribution. 99 100:doc:`Release notes for the current release <ReleaseNotes>` 101 This describes new features, known bugs, and other limitations. 102 103.. _lists-forums: 104 105Forums & Mailing Lists 106---------------------- 107 108If you can't find what you need in these docs, try consulting the 109Discourse forums. There are also commit mailing lists for all commits to the LLVM Project. 110The :doc:`CodeOfConduct` applies to all these forums and mailing lists. 111 112`LLVM Discourse`__ 113 The forums for all things LLVM and related sub-projects. There are categories and subcategories for a wide variety of areas within LLVM. You can also view tags or search for a specific topic. 114 115 .. __: https://discourse.llvm.org/ 116 117`Commits Archive (llvm-commits)`__ 118 This list contains all commit messages that are made when LLVM developers 119 commit code changes to the repository. It also serves as a forum for 120 patch review (i.e. send patches here). It is useful for those who want to 121 stay on the bleeding edge of LLVM development. This list is very high 122 volume. 123 124 .. __: http://lists.llvm.org/pipermail/llvm-commits/ 125 126`Bugs & Patches Archive (llvm-bugs)`__ 127 This list gets emailed every time a bug is opened and closed. It is 128 higher volume than the LLVM-dev list. 129 130 .. __: http://lists.llvm.org/pipermail/llvm-bugs/ 131 132`LLVM Announcements`__ 133 If you just want project wide announcements such as releases, developers meetings, or blog posts, then you should check out the Announcement category on LLVM Discourse. 134 135 .. __: https://discourse.llvm.org/c/announce/46 136 137.. _online-sync-ups: 138 139Online Sync-Ups 140--------------- 141 142A number of regular calls are organized on specific topics. It should be 143expected that the range of topics will change over time. At the time of 144writing, the following sync-ups are organized. 145The :doc:`CodeOfConduct` applies to all online sync-ups. 146 147If you'd like to organize a new sync-up, please add the info in the table 148below. Please also create a calendar event for it and invite [email protected] 149to the event, so that it'll show up on the :ref:`llvm-community-calendar`. 150 151.. list-table:: LLVM regular sync-up calls 152 :widths: 25 25 25 25 153 :header-rows: 1 154 155 * - Topic 156 - Frequency 157 - Calendar link 158 - Minutes/docs link 159 * - Loop Optimization Working Group 160 - Every 2 weeks on Wednesday 161 - `ics <./_static/LoopOptWG_invite.ics>`__ 162 - `Minutes/docs <https://docs.google.com/document/d/1sdzoyB11s0ccTZ3fobqctDpgJmRoFcz0sviKxqczs4g/edit>`__ 163 * - RISC-V 164 - Every 2 weeks on Thursday 165 - `ics <https://calendar.google.com/calendar/ical/lowrisc.org_0n5pkesfjcnp0bh5hps1p0bd80%40group.calendar.google.com/public/basic.ics>`__ 166 `gcal <https://calendar.google.com/calendar/b/1?cid=bG93cmlzYy5vcmdfMG41cGtlc2ZqY25wMGJoNWhwczFwMGJkODBAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__ 167 - 168 * - Scalable Vectors and Arm SVE 169 - Monthly, every 3rd Tuesday 170 - `ics <https://calendar.google.com/calendar/ical/bjms39pe6k6bo5egtsp7don414%40group.calendar.google.com/public/basic.ics>`__ 171 `gcal <https://calendar.google.com/calendar/u/0/[email protected]>`__ 172 - `Minutes/docs <https://docs.google.com/document/d/1UPH2Hzou5RgGT8XfO39OmVXKEibWPfdYLELSaHr3xzo/edit>`__ 173 * - ML Guided Compiler Optimizations 174 - Monthly 175 - 176 - `Minutes/docs <https://docs.google.com/document/d/1JecbplF09l3swTjze-UVeLh4L48svJxGVy4mz_e9Rhs/edit?usp=gmail#heading=h.ts9cmcjbir1j>`__ 177 * - `LLVM security group <https://llvm.org/docs/Security.html>`__ 178 - Monthly, every 3rd Tuesday 179 - `ics <https://calendar.google.com/calendar/ical/eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com/public/basic.ics>`__ 180 `gcal <https://calendar.google.com/calendar/embed?src=eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com>`__ 181 - `Minutes/docs <https://discourse.llvm.org/t/llvm-security-group-public-sync-ups/62735>`__ 182 * - `CIRCT <https://github.com/llvm/circt>`__ 183 - Weekly, on Wednesday 184 - 185 - `Minutes/docs <https://docs.google.com/document/d/1fOSRdyZR2w75D87yU2Ma9h2-_lEPL4NxvhJGJd-s5pk/edit#heading=h.mulvhjtr8dk9>`__ 186 * - `MLIR <https://mlir.llvm.org>`__ design meetings 187 - Weekly, on Thursdays 188 - 189 - `Minutes/docs <https://docs.google.com/document/d/1y_9f1AbfgcoVdJh4_aM6-BaSHvrHl8zuA5G4jv_94K8/edit#heading=h.cite1kolful9>`__ 190 * - flang 191 - Multiple meeting series, `documented here <https://github.com/llvm/llvm-project/blob/main/flang/docs/GettingInvolved.md#calls>`__ 192 - 193 - 194 * - OpenMP 195 - Multiple meeting series, `documented here <https://openmp.llvm.org/docs/SupportAndFAQ.html>`__ 196 - 197 - 198 * - LLVM Alias Analysis 199 - Every 4 weeks on Tuesdays 200 - `ics <http://lists.llvm.org/pipermail/llvm-dev/attachments/20201103/a3499a67/attachment-0001.ics>`__ 201 - `Minutes/docs <https://docs.google.com/document/d/17U-WvX8qyKc3S36YUKr3xfF-GHunWyYowXbxEdpHscw>`__ 202 * - Windows/COFF related developments 203 - Every 2 months on Thursday 204 - 205 - `Minutes/docs <https://docs.google.com/document/d/1A-W0Sas_oHWTEl_x_djZYoRtzAdTONMW_6l1BH9G6Bo/edit?usp=sharing>`__ 206 * - Vector Predication 207 - Every 2 weeks on Tuesdays, 3pm UTC 208 - 209 - `Minutes/docs <https://docs.google.com/document/d/1q26ToudQjnqN5x31zk8zgq_s0lem1-BF8pQmciLa4k8/edit?usp=sharing>`__ 210 * - LLVM Pointer Authentication 211 - Every month on Mondays 212 - `ics <https://calendar.google.com/calendar/ical/fr1qtmrmt2s9odufjvurkb6j70%40group.calendar.google.com/public/basic.ics>`__ 213 - `Minutes/docs <https://discourse.llvm.org/t/llvm-pointer-authentication-sync-ups/62661>`__ 214 * - MemorySSA in LLVM 215 - Every 8 weeks on Mondays 216 - `ics <https://calendar.google.com/calendar/ical/c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com/public/basic.ics>`__ 217 `gcal <https://calendar.google.com/calendar/embed?src=c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com>`__ 218 - `Minutes/docs <https://docs.google.com/document/d/1-uEEZfmRdPThZlctOq9eXlmUaSSAAi8oKxhrPY_lpjk/edit#>`__ 219 * - LLVM Embedded Toolchains 220 - Every 4 weeks on Thursdays 221 - `ics <https://drive.google.com/file/d/1uNa-PFYkhAfT83kR2Nc4Fi706TAQFBEL/view?usp=sharing>`__ 222 `gcal <https://calendar.google.com/calendar/u/0?cid=ZDQyc3ZlajJmbjIzNG1jaTUybjFsdjA2dWNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__ 223 - `Minutes/docs <https://docs.google.com/document/d/1GahxppHJ7o1O_fn1Mbidu1DHEg7V2aOr92LXCtNV1_o/edit?usp=sharing>`__ 224 * - Clang C and C++ Language Working Group 225 - 1st and 3rd Wednesday of the month 226 - `gcal <https://calendar.google.com/calendar/u/0?cid=cW1lZGg0ZXNpMnIyZDN2aTVydGVrdWF1YzRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__ 227 - `Minutes/docs <https://docs.google.com/document/d/1x5-RbOC6-jnI_NcJ9Dp4pSmGhhNe7lUevuWUIB46TeM/edit?usp=sharing>`__ 228 229.. _office-hours: 230 231Office hours 232------------ 233 234A number of experienced LLVM contributors make themselves available for a chat 235on a regular schedule, to anyone who is looking for some guidance. Please find 236the list of who is available when, through which medium, and what their area of 237expertise is. Don't be too shy to dial in! 238 239The :doc:`CodeOfConduct` applies to all office hours. 240 241Of course, people take time off from time to time, so if you dial in and you 242don't find anyone present, chances are they happen to be off that day. 243 244.. list-table:: LLVM office hours 245 :widths: 15 40 15 15 15 246 :header-rows: 1 247 248 * - Name 249 - In-scope topics 250 - When? 251 - Where? 252 - Languages 253 * - Kristof Beyls 254 - General questions on how to contribute to LLVM; organizing meetups; 255 submitting talks; and other general LLVM-related topics. Arm/AArch64 256 codegen. LLVM security group. LLVM Office Hours. 257 - Every 2nd and 4th Wednesday of the month at 9.30am CET, for 30 minutes. 258 `ics <https://calendar.google.com/calendar/ical/co0h4ndpvtfe64opn7eraiq3ac%40group.calendar.google.com/public/basic.ics>`__ 259 - `Jitsi <https://meet.jit.si/KristofBeylsLLVMOfficeHour>`__ 260 - English, Flemish, Dutch 261 * - Alina Sbirlea 262 - General questions on how to contribute to LLVM; women in compilers; 263 MemorySSA, BatchAA, various loop passes, new pass manager. 264 - Monthly, 2nd Tuesdays, 10.00am PT/7:00pm CET, for 30 minutes. 265 `ics <https://calendar.google.com/calendar/ical/c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com/public/basic.ics>`__ 266 `gcal <https://calendar.google.com/calendar/embed?src=c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com>`__ 267 - `GoogleMeet <https://meet.google.com/hhk-xpdj-gvx>`__ 268 - English, Romanian 269 * - Aaron Ballman 270 - Clang internals; frontend attributes; clang-tidy; clang-query; AST matchers 271 - Monthly, 2nd Monday of the month at 10:00am Eastern, for 30 minutes. 272 `ics <https://calendar.google.com/calendar/ical/npgke5dug0uliud0qapptmps58%40group.calendar.google.com/public/basic.ics>`__ 273 `gcal <https://calendar.google.com/calendar/embed?src=npgke5dug0uliud0qapptmps58%40group.calendar.google.com>`__ 274 - `GoogleMeet <https://meet.google.com/xok-iqne-gmi>`__ 275 - English, Norwegian (not fluently) 276 * - Johannes Doerfert (he/him) 277 - OpenMP, LLVM-IR, interprocedural optimizations, Attributor, workshops, research, ... 278 - Every 2 weeks, Wednesdays 10:30am (Chicago Time), for 1 hour. 279 `ics <https://outlook.office365.com/owa/calendar/[email protected]/4929bd0f955b4f9b82b7bc995cb3b1bf665030567582422766/S-1-8-2190330107-3188380388-3000953923-1819937831/reachcalendar.ics>`__ 280 - `MS Teams <https://teams.microsoft.com/l/meetup-join/19%3ameeting_MTM2ZDNkNGUtZjg3My00ZDFjLTk5NjctYTIwMmI3MWM4MjFj%40thread.v2/0?context=%7b%22Tid%22%3a%220cfca185-25f7-49e3-8ae7-704d5326e285%22%2c%22Oid%22%3a%220cacfb51-1523-4455-a443-adca936d1af0%22%7d>`__ 281 - English, German 282 * - Tobias Grosser 283 - General questions on how to contribute to LLVM/MLIR, Polly, Loop Optimization, FPL, Research in LLVM, PhD in CS, Summer of Code. 284 - Monthly, last Monday of the month at 18:00 London time (typically 9am PT), for 30 minutes. 285 - `Video Call <https://meet.grosser.science/LLVMOfficeHours>`__ 286 - English, German, Spanish, French 287 * - Anastasia Stulova 288 - Clang internals for C/C++ language extensions and dialects, OpenCL, GPU, SPIR-V, how to contribute, women in compilers. 289 - Monthly, 2nd Thursday of the month at 17:00 BST - London time (9:00am PT except for 2 weeks in spring), 1 hour slot. 290 - `GoogleMeet <https://meet.google.com/kdy-fdbv-nuk>`__ 291 - English, Russian, German (not fluently) 292 293 294Guidance for office hours hosts 295^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ 296 297* If you're interested in becoming an office hours host, please add your 298 information to the list above. Please create a calendar event for it and 299 invite [email protected] to the event so that it'll show up on the 300 :ref:`llvm-community-calendar`. 301* When starting an office hours session, consider typing something like "*Hi, 302 I'm available for chats in the next half hour at* video chat URL. *I'm 303 looking forward to having conversations on the video chat or here.*" on the 304 LLVM chat channels that you are already on. These could include: 305 306 * the `#office-hours Discord channel 307 <https://discord.com/channels/636084430946959380/976196303681896538>`__. 308 * :ref:`IRC` 309 310 Doing this can help: 311 * overcome potential anxiety to call in for a first time, 312 * people who prefer to first exchange a few messages through text chat 313 before dialing in, and 314 * remind the wider community that office hours do exist. 315* If you decide to no longer host office hours, please do remove your entry 316 from the list above. 317 318 319.. _IRC: 320 321IRC 322--- 323 324Users and developers of the LLVM project (including subprojects such as Clang) 325can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_. 326 327This channel has several bots. 328 329* Buildbot reporters 330 331 * llvmbb - Bot for the main LLVM buildbot master. 332 http://lab.llvm.org/buildbot/#/console 333 334* robot - Bugzilla linker. %bug <number> 335 336* clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running 337 near-trunk clang instead of gcc. 338 339In addition to the traditional IRC there is a 340`Discord <https://discord.com/channels/636084430946959380/636725486533345280>`_ 341chat server available. To sign up, please use this 342`invitation link <https://discord.com/invite/xS7Z362>`_. 343 344 345.. _meetups-social-events: 346 347Meetups and social events 348------------------------- 349 350.. toctree:: 351 :hidden: 352 353 MeetupGuidelines 354 355Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_, 356there are several user groups called 357`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to 358join one in your city. Or start a new one if there is none: 359 360:doc:`MeetupGuidelines` 361 362.. _community-proposals: 363 364Community wide proposals 365------------------------ 366 367Proposals for massive changes in how the community behaves and how the work flow 368can be better. 369 370.. toctree:: 371 :hidden: 372 373 Proposals/GitHubMove 374 BugpointRedesign 375 Proposals/TestSuite 376 Proposals/VariableNames 377 Proposals/VectorizationPlan 378 Proposals/VectorPredication 379 380:doc:`Proposals/GitHubMove` 381 Proposal to move from SVN/Git to GitHub. 382 383:doc:`BugpointRedesign` 384 Design doc for a redesign of the Bugpoint tool. 385 386:doc:`Proposals/TestSuite` 387 Proposals for additional benchmarks/programs for llvm's test-suite. 388 389:doc:`Proposals/VariableNames` 390 Proposal to change the variable names coding standard. 391 392:doc:`Proposals/VectorizationPlan` 393 Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer. 394 395:doc:`Proposals/VectorPredication` 396 Proposal for predicated vector instructions in LLVM. 397 398.. _llvm-community-calendar: 399 400LLVM community calendar 401----------------------- 402 403We aim to maintain a public calendar view of all events happening in the LLVM 404community such as :ref:`online-sync-ups` and :ref:`office-hours`. The calendar 405can be found at 406https://calendar.google.com/calendar/u/0/[email protected] and can 407also be seen inline below: 408 409.. raw:: html 410 411 <iframe src="https://calendar.google.com/calendar/embed?height=600&wkst=1&bgcolor=%23ffffff&ctz=UTC&showCalendars=0&showDate=1&showNav=1&src=Y2FsZW5kYXJAbGx2bS5vcmc&color=%23039BE5" style="border:solid 1px #777" width="800" height="600" frameborder="0" scrolling="no"></iframe> 412