580 lines · plain
1Getting Involved2================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 Contributing13 DeveloperPolicy14 CodeReview15 SupportPolicy16 SphinxQuickstartTemplate17 HowToSubmitABug18 BugLifeCycle19 CodingStandards20 GitHub21 GitBisecting22 GitRepositoryPolicy23 24:doc:`Contributing`25 An overview on how to contribute to LLVM.26 27:doc:`DeveloperPolicy`28 The LLVM project's policy towards developers and their contributions.29 30:doc:`CodeReview`31 The LLVM project's code-review process.32 33:doc:`SupportPolicy`34 The LLVM support policy for core and non-core components.35 36:doc:`SphinxQuickstartTemplate`37 A template + tutorial for writing new Sphinx documentation. It is meant38 to be read in source form.39 40:doc:`HowToSubmitABug`41 Instructions for properly submitting information about any bugs you run into42 in the LLVM system.43 44:doc:`BugLifeCycle`45 Describes how bugs are reported, triaged, and closed.46 47:doc:`CodingStandards`48 Details the LLVM coding standards and provides useful information on writing49 efficient C++ code.50 51:doc:`GitHub`52 Describes how to use the llvm-project repository and code reviews on GitHub.53 54:doc:`GitBisecting`55 Describes how to use ``git bisect`` on LLVM's repository.56 57:doc:`GitRepositoryPolicy`58 Collection of policies around the git repositories.59 60.. _development-process:61 62Development Process63-------------------64 65Information about LLVM's development process.66 67.. toctree::68 :hidden:69 70 Projects71 HowToReleaseLLVM72 ReleaseProcess73 HowToAddABuilder74 ReleaseNotes75 76:doc:`Projects`77 How-to guide and templates for new projects that *use* the LLVM78 infrastructure. The templates (directory organization, Makefiles, and test79 tree) allow the project code to be located outside (or inside) the ``llvm/``80 tree, while using LLVM header files and libraries.81 82:doc:`HowToReleaseLLVM`83 This is a guide to preparing LLVM releases. Most developers can ignore it.84 85:doc:`ReleaseProcess`86 This is a guide to validate a new release, during the release process. Most developers can ignore it.87 88:doc:`HowToAddABuilder`89 Instructions for adding new builder to LLVM buildbot master.90 91:doc:`Release notes for the current release <ReleaseNotes>`92 This describes new features, known bugs, and other limitations.93 94.. _lists-forums:95 96Forums & Mailing Lists97----------------------98 99If you can't find what you need in these docs, try consulting the100Discourse forums. There are also commit mailing lists for all commits to the LLVM Project.101The :doc:`CodeOfConduct` applies to all these forums and mailing lists.102 103`LLVM Discourse`__104 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.105 106 .. __: https://discourse.llvm.org/107 108`Commits Archive (llvm-commits)`__109 This list contains all commit messages that are made when LLVM developers110 commit code changes to the repository. It also serves as a forum for111 patch review (i.e., send patches here). It is useful for those who want to112 stay on the bleeding edge of LLVM development. This list is very high113 volume.114 115 .. __: http://lists.llvm.org/pipermail/llvm-commits/116 117`Bugs & Patches Archive (llvm-bugs)`__118 This list gets emailed every time a bug is opened and closed. It is119 higher volume than the LLVM-dev list.120 121 .. __: http://lists.llvm.org/pipermail/llvm-bugs/122 123`LLVM Announcements`__124 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.125 126 .. __: https://discourse.llvm.org/c/announce/46127 128.. _online-sync-ups:129 130Online Sync-Ups131---------------132 133A number of regular calls are organized on specific topics. It should be134expected that the range of topics will change over time. At the time of135writing, the following sync-ups are organized.136The :doc:`CodeOfConduct` applies to all online sync-ups.137 138If you'd like to organize a new sync-up, please add the info in the table139below. Please also create a calendar event for it and invite calendar@llvm.org140to the event, so that it'll show up on the :ref:`llvm-community-calendar`.141Please see :ref:`llvm-community-calendar-host-guidance` for more guidance on142what to add to your calendar invite.143 144.. list-table:: LLVM regular sync-up calls145 :widths: 25 25 25 25146 :header-rows: 1147 148 * - Topic149 - Frequency150 - Calendar link151 - Minutes/docs link152 * - Loop Optimization Working Group153 - Every first Wednesday of the month154 - `ics <./_static/LoopOptWG_invite.ics>`__155 - `Minutes/docs <https://docs.google.com/document/d/1sdzoyB11s0ccTZ3fobqctDpgJmRoFcz0sviKxqczs4g/edit>`__156 * - RISC-V157 - Every 2 weeks on Thursday158 - `ics <https://calendar.google.com/calendar/ical/lowrisc.org_0n5pkesfjcnp0bh5hps1p0bd80%40group.calendar.google.com/public/basic.ics>`__159 `gcal <https://calendar.google.com/calendar/b/1?cid=bG93cmlzYy5vcmdfMG41cGtlc2ZqY25wMGJoNWhwczFwMGJkODBAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__160 - `Minutes/docs <https://docs.google.com/document/d/1G3ocHm2zE6AYTS2N3_3w2UxFnSEyKkcF57siLWe-NVs>`__161 * - ML Guided Compiler Optimizations162 - Monthly163 -164 - `Minutes/docs <https://docs.google.com/document/d/1JecbplF09l3swTjze-UVeLh4L48svJxGVy4mz_e9Rhs/edit?usp=gmail#heading=h.ts9cmcjbir1j>`__165 * - `LLVM security group <https://llvm.org/docs/Security.html>`__166 - Monthly, every 3rd Tuesday167 - `ics <https://calendar.google.com/calendar/ical/eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com/public/basic.ics>`__168 `gcal <https://calendar.google.com/calendar/embed?src=eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com>`__169 - `Minutes/docs <https://discourse.llvm.org/t/llvm-security-group-public-sync-ups/62735>`__170 * - `CIRCT <https://github.com/llvm/circt>`__171 - Weekly, on Wednesday172 -173 - `Minutes/docs <https://docs.google.com/document/d/1fOSRdyZR2w75D87yU2Ma9h2-_lEPL4NxvhJGJd-s5pk/edit#heading=h.mulvhjtr8dk9>`__174 * - flang175 - Multiple meeting series, `documented here <https://github.com/llvm/llvm-project/blob/main/flang/docs/GettingInvolved.md#calls>`__176 -177 -178 * - OpenMP179 - Multiple meeting series, `documented here <https://openmp.llvm.org/docs/SupportAndFAQ.html>`__180 -181 -182 * - LLVM Alias Analysis183 - Every 4 weeks on Tuesdays184 - `ics <http://lists.llvm.org/pipermail/llvm-dev/attachments/20201103/a3499a67/attachment-0001.ics>`__185 - `Minutes/docs <https://docs.google.com/document/d/17U-WvX8qyKc3S36YUKr3xfF-GHunWyYowXbxEdpHscw>`__186 * - LLVM Pointer Authentication187 - Every month on Mondays188 - `ics <https://calendar.google.com/calendar/ical/fr1qtmrmt2s9odufjvurkb6j70%40group.calendar.google.com/public/basic.ics>`__189 - `Minutes/docs <https://discourse.llvm.org/t/llvm-pointer-authentication-sync-ups/62661>`__190 * - LLVM Embedded Toolchains191 - Every 4 weeks on Thursdays192 - `ics <https://drive.google.com/file/d/1uNa-PFYkhAfT83kR2Nc4Fi706TAQFBEL/view?usp=sharing>`__193 `gcal <https://calendar.google.com/calendar/u/0?cid=ZDQyc3ZlajJmbjIzNG1jaTUybjFsdjA2dWNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__194 - `Minutes/docs <https://docs.google.com/document/d/1GahxppHJ7o1O_fn1Mbidu1DHEg7V2aOr92LXCtNV1_o/edit?usp=sharing>`__195 * - Clang C and C++ Language Working Group196 - 1st and 3rd Wednesday of the month197 - `gcal <https://calendar.google.com/calendar/u/0?cid=cW1lZGg0ZXNpMnIyZDN2aTVydGVrdWF1YzRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ>`__198 - `Minutes/docs <https://docs.google.com/document/d/1x5-RbOC6-jnI_NcJ9Dp4pSmGhhNe7lUevuWUIB46TeM/edit?usp=sharing>`__199 * - LLVM SPIR-V Backend Working Group200 - Every week on Monday201 -202 - `Meeting details/agenda <https://docs.google.com/document/d/1UjX-LAwPjJ75Nmb8a5jz-Qrm-pPtKtQw0k1S1Lop9jU/edit?usp=sharing>`__203 * - SYCL Upstream Working Group204 - Every 2 weeks on Mondays205 - `gcal <https://calendar.google.com/calendar/u/0?cid=c3ljbC5sbHZtLndnQGdtYWlsLmNvbQ>`__206 - `Meeting details/agenda <https://docs.google.com/document/d/1ivYDSn_5ChTeiZ7TiO64WC_jYJnGwAUiT9Ngi9cAdFU/edit?usp=sharing>`__207 * - Vectorizer Improvement Working Group208 - 3rd Tuesday of the month209 - `ics <https://drive.google.com/file/d/1ten-u-4yjOcCoONUtR4_AxsFxRDTUp1b/view?usp=sharing>`__210 - `Meeting details/agenda: <https://docs.google.com/document/d/1Glzy2JiWuysbD-HBWGUOkZqT09GJ4_Ljodr0lXD5XfQ/edit>`__211 * - `LLVM Qualification Working Group <https://llvm.org/docs/QualGroup.html>`__212 - 1st Tuesday of the month213 - `ics <https://calendar.google.com/calendar/ical/c_fe5774fa2769c5085d6b87e8fac272e8940e7d0089bc0e0a58dc3ead7978504b%40group.calendar.google.com/public/basic.ics>`__214 `gcal <https://calendar.google.com/calendar/embed?src=c_fe5774fa2769c5085d6b87e8fac272e8940e7d0089bc0e0a58dc3ead7978504b%40group.calendar.google.com&ctz=Asia%2FTokyo>`__215 - `Minutes/docs <https://discourse.llvm.org/t/llvm-qualification-wg-sync-ups-meeting-minutes/87148>`__216 * - MLIR C/C++ Frontend Working Group217 - Monthly, usually 1st Monday of the month218 - `ics <https://calendar.google.com/calendar/ical/jvceakm3kbpku3f4jrsv1lkigo%40group.calendar.google.com/public/basic.ics>`__219 `gcal <https://calendar.google.com/calendar/embed?src=jvceakm3kbpku3f4jrsv1lkigo%40group.calendar.google.com&ctz=America%2FLos_Angeles>`__220 - `Minutes/docs <https://docs.google.com/document/d/1-flHK3TjQUrkSO2Fdt4webZ2zCyeXxpTLMiRQbMW7hE>`__221 * - ClangIR Upstreaming Coordination Meeting222 - Every 2 weeks on Mondays223 - `ics <https://calendar.google.com/calendar/ical/c_673c6cd64474c0aff173bf8fa609559f93d654e0984d9d91d71abd32d28c0486%40group.calendar.google.com/public/basic.ics>`__224 `gcal <https://calendar.google.com/calendar/embed?src=c_673c6cd64474c0aff173bf8fa609559f93d654e0984d9d91d71abd32d28c0486%40group.calendar.google.com&ctz=America%2FLos_Angeles>`__225 -226 * - GlobalISel227 - Every 2nd Tuesday of the month228 - `gcal <https://calendar.google.com/calendar/u/0?cid=YWZjNzhmMzE4MDNlNTAyNGY1NmE1MDIyODY0YTYwZmJmYzRjYTEwNTE1NmUxODA2NzBkYTliY2ZhYTVkNjk0NUBncm91cC5jYWxlbmRhci5nb29nbGUuY29t>`__229 - `Meeting details/agenda <https://docs.google.com/document/d/1Ry8O4-Tm5BFj9AMjr8qTQFU80z-ptiNQ62687NaIvLs/edit?usp=sharing>`__230 231 232For event owners, our Discord bot also supports sending automated announcements233of upcoming sync-ups. Please see the :ref:`discord-bot-event-pings` section for234info.235 236Past online sync-ups237^^^^^^^^^^^^^^^^^^^^238 239Some online sync-ups are no longer happening. We keep pointing to them here to240keep track of the meeting notes and in case anyone would want to revive them in241the future.242 243.. list-table:: LLVM no-longer-happening sync-up calls244 :widths: 25 25 25 25245 :header-rows: 1246 247 * - Topic248 - Frequency249 - Calendar link250 - Minutes/docs link251 * - Scalable Vectors and Arm SVE252 - Monthly, every 3rd Tuesday253 - `ics <https://calendar.google.com/calendar/ical/bjms39pe6k6bo5egtsp7don414%40group.calendar.google.com/public/basic.ics>`__254 `gcal <https://calendar.google.com/calendar/u/0/embed?src=bjms39pe6k6bo5egtsp7don414@group.calendar.google.com>`__255 - `Minutes/docs <https://docs.google.com/document/d/1UPH2Hzou5RgGT8XfO39OmVXKEibWPfdYLELSaHr3xzo/edit>`__256 * - MemorySSA in LLVM257 - Every 8 weeks on Mondays258 - `ics <https://calendar.google.com/calendar/ical/c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com/public/basic.ics>`__259 `gcal <https://calendar.google.com/calendar/embed?src=c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com>`__260 - `Minutes/docs <https://docs.google.com/document/d/1-uEEZfmRdPThZlctOq9eXlmUaSSAAi8oKxhrPY_lpjk/edit#>`__261 * - Vector Predication262 - Every 2 weeks on Tuesdays, 3pm UTC263 -264 - `Minutes/docs <https://docs.google.com/document/d/1q26ToudQjnqN5x31zk8zgq_s0lem1-BF8pQmciLa4k8/edit?usp=sharing>`__265 * - `MLIR <https://mlir.llvm.org>`__ design meetings266 - Weekly, on Thursdays267 -268 - `Minutes/docs <https://docs.google.com/document/d/1y_9f1AbfgcoVdJh4_aM6-BaSHvrHl8zuA5G4jv_94K8/edit#heading=h.cite1kolful9>`__269 270.. _office-hours:271 272Office hours273------------274 275A number of experienced LLVM contributors make themselves available for a chat276on a regular schedule, to anyone who is looking for some guidance. Please find277the list of who is available when, through which medium, and what their area of278expertise is. Don't be too shy to dial in!279 280Office hours are also listed on the :ref:`llvm-community-calendar`. Of course,281people take time off from time to time, so if you dial in and you don't find282anyone present, chances are they happen to be off that day.283 284The :doc:`CodeOfConduct` applies to all office hours.285 286.. list-table:: LLVM office hours287 :widths: 15 40 15 15 15288 :header-rows: 1289 290 * - Name291 - In-scope topics292 - When?293 - Where?294 - Languages295 * - Kristof Beyls296 - General questions on how to contribute to LLVM; organizing meetups;297 submitting talks; and other general LLVM-related topics. Arm/AArch64298 codegen. LLVM security group. LLVM Office Hours.299 - Every 2nd and 4th Wednesday of the month at 9.30am CET, for 30 minutes.300 `ics <https://calendar.google.com/calendar/ical/co0h4ndpvtfe64opn7eraiq3ac%40group.calendar.google.com/public/basic.ics>`__301 - `Jitsi <https://meet.jit.si/KristofBeylsLLVMOfficeHour>`__302 - English, Flemish, Dutch303 * - Alina Sbirlea304 - General questions on how to contribute to LLVM; women in compilers;305 MemorySSA, BatchAA, various loop passes, new pass manager.306 - Monthly, 2nd Tuesdays, 10.00am PT/7:00pm CET, for 30 minutes.307 `ics <https://calendar.google.com/calendar/ical/c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com/public/basic.ics>`__308 `gcal <https://calendar.google.com/calendar/embed?src=c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com>`__309 - `GoogleMeet <https://meet.google.com/hhk-xpdj-gvx>`__310 - English, Romanian311 * - Aaron Ballman (he/him)312 - Clang internals; frontend attributes; clang-tidy; clang-query; AST matchers313 - Monthly, 2nd Monday and 3rd Friday of the month at 10:00am Eastern and again at 2:00pm Eastern, for 60 minutes.314 `ics <https://calendar.google.com/calendar/ical/npgke5dug0uliud0qapptmps58%40group.calendar.google.com/public/basic.ics>`__315 `gcal <https://calendar.google.com/calendar/embed?src=npgke5dug0uliud0qapptmps58%40group.calendar.google.com>`__316 - `GoogleMeet <https://meet.google.com/xok-iqne-gmi>`__317 - English, Norwegian (not fluently)318 * - Johannes Doerfert (he/him)319 - OpenMP, LLVM-IR, interprocedural optimizations, Attributor, workshops, research, ...320 - Every week, Wednesdays 9:30am (Pacific Time), for 1 hour.321 `ics <https://drive.google.com/file/d/1E_QkRvirmdJzlXf2EKBUX-v8Xj7-eW3v/view?usp=sharing>`__322 - `MS Teams <https://teams.microsoft.com/l/meetup-join/19%3ameeting_MTMxNzU4MWYtYzViNS00OTM2LWJmNWQtMjg5ZWFhNGVjNzgw%40thread.v2/0?context=%7b%22Tid%22%3a%22a722dec9-ae4e-4ae3-9d75-fd66e2680a63%22%2c%22Oid%22%3a%22885bda30-ce8e-46db-aa7e-15de0474831a%22%7d>`__323 - English, German324 * - Tobias Grosser325 - General questions on how to contribute to LLVM/MLIR, Polly, Loop Optimization, FPL, Research in LLVM, PhD in CS, Summer of Code.326 - Monthly, last Monday of the month at 18:00 London time (typically 9am PT), for 30 minutes.327 - `Video Call <https://meet.grosser.science/LLVMOfficeHours>`__328 - English, German, Spanish, French329 * - Alexey Bader330 - SYCL compiler, offload tools, OpenCL and SPIR-V, how to contribute.331 - Monthly, 2nd Monday of the month at 9:30am PT, for 30 minutes.332 - `GoogleMeet <https://meet.google.com/pdz-xhns-uus>`__333 - English, Russian334 * - Maksim Panchenko335 - BOLT internals, IR, new passes, proposals, etc.336 - Monthly, 2nd Wednesday of the month at 11:00am PT, for 30 minutes.337 - `Zoom <https://fb.zoom.us/j/97065697120?pwd=NTFaUWJjZW9uVkJuaVlPTE9qclE3dz09>`__338 - English, Russian339 * - Quentin Colombet (he/him)340 - LLVM/MLIR; Codegen (Instruction selection (GlobalISel/SDISel), Machine IR,341 Register allocation, etc.); Optimizations; MCA342 - Monthly, 1st Wednesday of the month at 8.00am PT, for 30 minutes.343 `ics <https://calendar.google.com/calendar/ical/48c4ad60290a4df218e51e1ceec1106fe317b0ebc76938d9273592053f38204e%40group.calendar.google.com/public/basic.ics>`__344 `gcal <https://calendar.google.com/calendar/embed?src=48c4ad60290a4df218e51e1ceec1106fe317b0ebc76938d9273592053f38204e%40group.calendar.google.com>`__345 - `Google meet <https://meet.google.com/cbz-grrp-obs>`__346 - English, French347 * - Phoebe Wang (she/her)348 - X86 backend, General questions to X86, women in compilers.349 - Monthly, 3rd Wednesday of the month at 8:30am Beijing time, for 30 minutes.350 - `MS Teams <https://teams.microsoft.com/l/meetup-join/19%3ameeting_NWQ0MjU0NjYtZjUyMi00YTU3LThmM2EtY2Y2YTE4NGM3NmFi%40thread.v2/0?context=%7b%22Tid%22%3a%2246c98d88-e344-4ed4-8496-4ed7712e255d%22%2c%22Oid%22%3a%227b309d9c-a9bb-44c8-a940-ab97eef42d4d%22%7d>`__351 - English, Chinese352 * - Amara Emerson353 - GlobalISel questions.354 - Monthly, 4th Wednesday of the month at 9:30am PT, for 30 minutes.355 - `Google meet <https://meet.google.com/pdd-dibg-cwv>`__356 - English357 * - Maksim Levental and Jeremy Kun358 - MLIR newcomers and general discussion (`livestreamed <https://www.youtube.com/playlist?list=PLhxO86S3jsX2k7kOhZaV-qKWm8tNsUdAE>`__)359 - Every two weeks, Wednesdays at 2:00pm US Pacific, for 90 minutes.360 - Livestream chat or `Google meet <https://meet.google.com/wit-tvzc-dwc>`__361 - English362 * - Renato Golin363 - General LLVM, MLIR & Linalg, distributed computing, research, socials.364 - Every first Friday of the month, 14:00 UK time, for 60 minutes.365 - `Google meet <https://meet.google.com/jps-twgq-ivz>`__366 - English, Portuguese367 368For event owners, our Discord bot also supports sending automated announcements369of upcoming office hours. Please see the :ref:`discord-bot-event-pings` section370for info.371 372Guidance for office hours hosts373^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^374 375* If you're interested in becoming an office hours host, please add your376 information to the list above. Please create a calendar event for it and377 invite calendar@llvm.org to the event so that it'll show up on the378 :ref:`llvm-community-calendar`.379 Please see :ref:`llvm-community-calendar-host-guidance` for more guidance on380 what to add to your calendar invite.381* When starting an office hours session, if you haven't set up the Discord bot382 integration, consider typing something like "*Hi, I'm available for chats in383 the next half hour at* video chat URL. *I'm looking forward to having384 conversations on the video chat or here.*" on the385 `#office-hours Discord channel <https://discord.com/channels/636084430946959380/976196303681896538>`__.386 387 Doing this can help:388 * overcome potential anxiety to call in for a first time,389 * people who prefer to first exchange a few messages through text chat390 before dialing in, and391 * remind the wider community that office hours do exist.392* If you decide to no longer host office hours, please do remove your entry393 from the list above.394 395 396Discord397-------398 399Users and developers of the LLVM project (including subprojects such as Clang)400can be found on the community's `Discord <https://discord.gg/xS7Z362>`_401chat server. The server is actively moderated.402 403The #buildbot-status channel has a bot for404`LLVM buildbot <http://lab.llvm.org/buildbot/#/console>`_ status changes. The405bot will update the channel with a link to a build bot when a build goes from406passing to failing and again when the build goes from failing back to passing.407It is a great way to actively monitor the status of the build.408 409The bot also supports @mention-ing you when your email appears on a blamelist.410For more details, DM ``help`` to the bot.411 412.. _discord-bot-event-pings:413 414Discord bot event pings415^^^^^^^^^^^^^^^^^^^^^^^416 417Our Discord bot supports automatically sending messages about upcoming events418on `the LLVM community calendar <https://calendar.google.com/calendar/u/0/embed?src=calendar@llvm.org>`_419to Discord. This behavior is controlled on a per-event basis, by metadata in the420event's description. Each piece of metadata should be on its own line in the421event description.422 423The currently supported metadata is:424 425- ``discord-bot-event-type`` - **Required**. Specifies the event type. Valid426 values are ``office-hours`` and ``sync-up``.427- ``discord-bot-channels-to-mention`` - **Sometimes required**. A428 comma-separated list of Discord channels to post notifications in. If your429 ``discord-bot-event-type`` is ``office-hours``, the ``#office-hours`` channel430 will be implicitly appended to this list (ergo, you don't need to specify this431 item). Otherwise, you must specify a value here.432- ``discord-bot-mention`` - **Optional**. A comma-separated list of people to433 ping on each event notification. All names mentioned must be Discord434 usernames, and must have a leading ``@``. e.g., ``@foo, @bar``.435- ``discord-bot-reminder-time-before-start`` - **Optional**. The number of436 minutes before the beginning of an event to send a ping. This should be437 formatted as an integer. Defaults to 30.438- ``discord-bot-message`` - **Optional**. Text to append to all event pings.439 440An example of an event description with valid metadata is::441 442 Regular office hours to chat with people about LLVM! We can help with443 questions, troubleshooting bugs, etc.444 445 discord-bot-channels-to-mention: #beginners, #foo446 discord-bot-event-type: office-hours447 discord-bot-mention: @gburgessiv, @bar448 discord-bot-message: Come join us for office hours!449 discord-bot-reminder-time-before-start: 5450 451This metadata will prompt the Discord bot to:452 453* send pings 5 minutes before the given event starts, mentioning ``@gburgessiv``454 and ``@bar`` in the ping455* send the pings to the ``#beginners``, ``#foo``, and ``#office-hours`` channels456* include the text "Come join us for office hours!" in the ping457 458A few minutes before sending a ping, the bot will double-check that the event459hasn't been cancelled.460 461If you need help troubleshooting, or have feature requests/questions, please462feel free to ping @gburgessiv!463 464.. _meetups-social-events:465 466Meetups and social events467-------------------------468 469.. toctree::470 :hidden:471 472 MeetupGuidelines473 474Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,475there are several user groups called476`LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to477join one in your city. Or start a new one if there is none:478 479:doc:`MeetupGuidelines`480 481.. _community-proposals:482 483Community wide proposals484------------------------485 486Proposals for large-scale changes in how the community behaves and how the work flow487can be better.488 489.. toctree::490 :hidden:491 492 Proposals/GitHubMove493 BugpointRedesign494 Proposals/TestSuite495 Proposals/VariableNames496 Proposals/VectorPredication497 498:doc:`Proposals/GitHubMove`499 Proposal to move from SVN/Git to GitHub.500 501:doc:`BugpointRedesign`502 Design doc for a redesign of the Bugpoint tool.503 504:doc:`Proposals/TestSuite`505 Proposals for additional benchmarks/programs for llvm's test-suite.506 507:doc:`Proposals/VariableNames`508 Proposal to change the variable names coding standard.509 510:doc:`Proposals/VectorPredication`511 Proposal for predicated vector instructions in LLVM.512 513.. _llvm-community-calendar:514 515LLVM community calendar516-----------------------517 518We aim to maintain a public calendar view of all events happening in the LLVM519community such as :ref:`online-sync-ups` and :ref:`office-hours`. The calendar520can be found at521https://calendar.google.com/calendar/u/0/embed?src=calendar@llvm.org and can522also be seen inline below:523 524.. raw:: html525 526 <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>527 528Note that the web view of the LLVM community calendar shows events in529Coordinated Universal Time (UTC). If you use Google Calendar, consider530subscribing to it with the + button in the bottom-right corner to view all531events in your local time zone alongside your other calendars.532 533.. _llvm-community-calendar-host-guidance:534 535Guidance on what to put into LLVM community calendar invites536^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^537 538To add your event, create a calendar event for it and invite calendar@llvm.org539on it. Your event should then show up on the community calendar.540 541Please put the following pieces of information in your calendar invite:542 543* Write a single paragraph describing what the event is about. Include things544 such as who the event is for and what sort of topics are discussed.545* State explicitly that the :doc:`CodeOfConduct` applies to this event.546* Make it clear who:547 548 * the organizer is.549 550 * the person to contact is in case of any code-of-conduct issues. Typically,551 this would be the organizer.552 553* If you have meeting minutes for your event, add a pointer to where those live.554 A good place for meeting minutes could be as a post on LLVM Discourse.555 556* If you're hosting a sync-up or office hours event and would like it to be557 announced by the Discord bot, add the relevant metadata (full descriptions558 available in the :ref:`discord-bot-event-pings` section).559 560An example invite looks as follows561 562.. code-block:: none563 564 This event is a meetup for all developers of LLDB. Meeting agendas are posted565 on Discourse before the event.566 567 Attendees must adhere to the LLVM Code of Conduct568 (https://llvm.org/docs/CodeOfConduct.html). For any Code of Conduct reports,569 please contact the organizers and also email conduct@llvm.org.570 571 Agenda/Meeting Minutes: Link to minutes572 573 Organizer(s): First Surname (name@email.com)574 575 discord-bot-channels-to-mention: #lldb576 discord-bot-event-type: sync-up577 discord-bot-mention: @host-username, @another-host578 discord-bot-message: Come join us to chat about LLDB!579 discord-bot-reminder-time-before-start: 30580