llvm/docs/GettingInvolved.rst

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