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 .. toctree::\r
   7    :hidden:\r
   8 \r
   9    Contributing\r
  10    DeveloperPolicy\r
  11    SphinxQuickstartTemplate\r
  12    Phabricator\r
  13    HowToSubmitABug\r
  14    BugLifeCycle\r
  15    CodingStandards\r
  16 \r
  17 :doc:`Contributing`\r
  18    An overview on how to contribute to LLVM.\r
  19 \r
  20 :doc:`DeveloperPolicy`\r
  21    The LLVM project's policy towards developers and their contributions.\r
  22 \r
  23 :doc:`SphinxQuickstartTemplate`\r
  24   A template + tutorial for writing new Sphinx documentation. It is meant\r
  25   to be read in source form.\r
  26 \r
  27 :doc:`Phabricator`\r
  28    Describes how to use the Phabricator code review tool hosted on\r
  29    http://reviews.llvm.org/ and its command line interface, Arcanist.\r
  30 \r
  31 :doc:`HowToSubmitABug`\r
  32    Instructions for properly submitting information about any bugs you run into\r
  33    in the LLVM system.\r
  34 \r
  35 :doc:`BugLifeCycle`\r
  36    Describes how bugs are reported, triaged and closed.\r
  37 \r
  38 :doc:`CodingStandards`\r
  39   Details the LLVM coding standards and provides useful information on writing\r
  40   efficient C++ code.\r
  41 \r
  42 .. _development-process:\r
  43 \r
  44 Development Process\r
  45 -------------------\r
  46 \r
  47 Information about LLVM's development process.\r
  48 \r
  49 .. toctree::\r
  50    :hidden:\r
  51 \r
  52    Projects\r
  53    LLVMBuild\r
  54    HowToReleaseLLVM\r
  55    Packaging\r
  56    ReleaseProcess\r
  57    HowToAddABuilder\r
  58    ReleaseNotes\r
  59 \r
  60 :doc:`Projects`\r
  61   How-to guide and templates for new projects that *use* the LLVM\r
  62   infrastructure.  The templates (directory organization, Makefiles, and test\r
  63   tree) allow the project code to be located outside (or inside) the ``llvm/``\r
  64   tree, while using LLVM header files and libraries.\r
  65 \r
  66 :doc:`LLVMBuild`\r
  67   Describes the LLVMBuild organization and files used by LLVM to specify\r
  68   component descriptions.\r
  69 \r
  70 :doc:`HowToReleaseLLVM`\r
  71   This is a guide to preparing LLVM releases. Most developers can ignore it.\r
  72 \r
  73 :doc:`ReleaseProcess`\r
  74   This is a guide to validate a new release, during the release process. Most developers can ignore it.\r
  75 \r
  76 :doc:`HowToAddABuilder`\r
  77    Instructions for adding new builder to LLVM buildbot master.\r
  78 \r
  79 :doc:`Packaging`\r
  80    Advice on packaging LLVM into a distribution.\r
  81 \r
  82 :doc:`Release notes for the current release <ReleaseNotes>`\r
  83    This describes new features, known bugs, and other limitations.\r
  84 \r
  85 .. _mailing-lists:\r
  86 \r
  87 Mailing Lists\r
  88 -------------\r
  89 \r
  90 If you can't find what you need in these docs, try consulting the mailing\r
  91 lists.\r
  92 \r
  93 `Developer's List (llvm-dev)`__\r
  94   This list is for people who want to be included in technical discussions of\r
  95   LLVM. People post to this list when they have questions about writing code\r
  96   for or using the LLVM tools. It is relatively low volume.\r
  97 \r
  98   .. __: http://lists.llvm.org/mailman/listinfo/llvm-dev\r
  99 \r
 100 `Commits Archive (llvm-commits)`__\r
 101   This list contains all commit messages that are made when LLVM developers\r
 102   commit code changes to the repository. It also serves as a forum for\r
 103   patch review (i.e. send patches here). It is useful for those who want to\r
 104   stay on the bleeding edge of LLVM development. This list is very high\r
 105   volume.\r
 106 \r
 107   .. __: http://lists.llvm.org/pipermail/llvm-commits/\r
 108 \r
 109 `Bugs & Patches Archive (llvm-bugs)`__\r
 110   This list gets emailed every time a bug is opened and closed. It is\r
 111   higher volume than the LLVM-dev list.\r
 112 \r
 113   .. __: http://lists.llvm.org/pipermail/llvm-bugs/\r
 114 \r
 115 `Test Results Archive (llvm-testresults)`__\r
 116   A message is automatically sent to this list by every active nightly tester\r
 117   when it completes.  As such, this list gets email several times each day,\r
 118   making it a high volume list.\r
 119 \r
 120   .. __: http://lists.llvm.org/pipermail/llvm-testresults/\r
 121 \r
 122 `LLVM Announcements List (llvm-announce)`__\r
 123   This is a low volume list that provides important announcements regarding\r
 124   LLVM.  It gets email about once a month.\r
 125 \r
 126   .. __: http://lists.llvm.org/mailman/listinfo/llvm-announce\r
 127 \r
 128 IRC\r
 129 ---\r
 130 \r
 131 Users and developers of the LLVM project (including subprojects such as Clang)\r
 132 can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm>`_.\r
 133 \r
 134 This channel has several bots.\r
 135 \r
 136 * Buildbot reporters\r
 137 \r
 138   * llvmbb - Bot for the main LLVM buildbot master.\r
 139     http://lab.llvm.org:8011/console\r
 140   * smooshlab - Apple's internal buildbot master.\r
 141 \r
 142 * robot - Bugzilla linker. %bug <number>\r
 143 \r
 144 * clang-bot - A `geordi <http://www.eelis.net/geordi/>`_ instance running\r
 145   near-trunk clang instead of gcc.\r
 146 \r
 147 .. _meetups-social-events:\r
 148 \r
 149 Meetups and social events\r
 150 -------------------------\r
 151 \r
 152 .. toctree::\r
 153    :hidden:\r
 154 \r
 155    MeetupGuidelines\r
 156 \r
 157 Besides developer `meetings and conferences <https://llvm.org/devmtg/>`_,\r
 158 there are several user groups called\r
 159 `LLVM Socials <https://www.meetup.com/pro/llvm/>`_. We greatly encourage you to\r
 160 join one in your city. Or start a new one if there is none:\r
 161 \r
 162 :doc:`MeetupGuidelines`\r
 163 \r
 164 .. _community-proposals:\r
 165 \r
 166 Community wide proposals\r
 167 ------------------------\r
 168 \r
 169 Proposals for massive changes in how the community behaves and how the work flow\r
 170 can be better.\r
 171 \r
 172 .. toctree::\r
 173    :hidden:\r
 174 \r
 175    CodeOfConduct\r
 176    Proposals/GitHubMove\r
 177    BugpointRedesign\r
 178    Proposals/LLVMLibC\r
 179    Proposals/TestSuite\r
 180    Proposals/VariableNames\r
 181    Proposals/VectorizationPlan\r
 182 \r
 183 :doc:`CodeOfConduct`\r
 184    Proposal to adopt a code of conduct on the LLVM social spaces (lists, events,\r
 185    IRC, etc).\r
 186 \r
 187 :doc:`Proposals/GitHubMove`\r
 188    Proposal to move from SVN/Git to GitHub.\r
 189 \r
 190 :doc:`BugpointRedesign`\r
 191    Design doc for a redesign of the Bugpoint tool.\r
 192 \r
 193 :doc:`Proposals/LLVMLibC`\r
 194    Proposal to add a libc implementation under the LLVM project.\r
 195 \r
 196 :doc:`Proposals/TestSuite`\r
 197    Proposals for additional benchmarks/programs for llvm's test-suite.\r
 198 \r
 199 :doc:`Proposals/VariableNames`\r
 200    Proposal to change the variable names coding standard.\r
 201 \r
 202 :doc:`Proposals/VectorizationPlan`\r
 203    Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.