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