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