LLVM welcomes contributions of all kinds. To get started, please review the following topics:
.. toctree:: :hidden: Contributing DeveloperPolicy CodeReview SupportPolicy SphinxQuickstartTemplate Phabricator HowToSubmitABug BugLifeCycle CodingStandards GitBisecting GitRepositoryPolicy
- :doc:`Contributing`
- An overview on how to contribute to LLVM.
- :doc:`DeveloperPolicy`
- The LLVM project's policy towards developers and their contributions.
- :doc:`CodeReview`
- The LLVM project's code-review process.
- :doc:`SupportPolicy`
- The LLVM support policy for core and non-core components.
- :doc:`SphinxQuickstartTemplate`
- A template + tutorial for writing new Sphinx documentation. It is meant to be read in source form.
- :doc:`Phabricator`
- Describes how to use the Phabricator code review tool hosted on http://reviews.llvm.org/ and its command line interface, Arcanist.
- :doc:`HowToSubmitABug`
- Instructions for properly submitting information about any bugs you run into in the LLVM system.
- :doc:`BugLifeCycle`
- Describes how bugs are reported, triaged and closed.
- :doc:`CodingStandards`
- Details the LLVM coding standards and provides useful information on writing efficient C++ code.
- :doc:`GitBisecting`
- Describes how to use
git bisecton LLVM's repository. - :doc:`GitRepositoryPolicy`
- Collection of policies around the git repositories.
Information about LLVM's development process.
.. toctree:: :hidden: Projects HowToReleaseLLVM Packaging ReleaseProcess HowToAddABuilder ReleaseNotes
- :doc:`Projects`
- How-to guide and templates for new projects that use the LLVM
infrastructure. The templates (directory organization, Makefiles, and test
tree) allow the project code to be located outside (or inside) the
llvm/tree, while using LLVM header files and libraries. - :doc:`HowToReleaseLLVM`
- This is a guide to preparing LLVM releases. Most developers can ignore it.
- :doc:`ReleaseProcess`
- This is a guide to validate a new release, during the release process. Most developers can ignore it.
- :doc:`HowToAddABuilder`
- Instructions for adding new builder to LLVM buildbot master.
- :doc:`Packaging`
- Advice on packaging LLVM into a distribution.
- :doc:`Release notes for the current release <ReleaseNotes>`
- This describes new features, known bugs, and other limitations.
If you can't find what you need in these docs, try consulting the mailing lists. In addition to the traditional mailing lists there is also a Discourse server available.
- Developer's List (llvm-dev)
- This list is for people who want to be included in technical discussions of LLVM. People post to this list when they have questions about writing code for or using the LLVM tools. It is relatively low volume.
- Commits Archive (llvm-commits)
- This list contains all commit messages that are made when LLVM developers commit code changes to the repository. It also serves as a forum for patch review (i.e. send patches here). It is useful for those who want to stay on the bleeding edge of LLVM development. This list is very high volume.
- Bugs & Patches Archive (llvm-bugs)
- This list gets emailed every time a bug is opened and closed. It is higher volume than the LLVM-dev list.
- Test Results Archive (llvm-testresults)
- A message is automatically sent to this list by every active nightly tester when it completes. As such, this list gets email several times each day, making it a high volume list.
- LLVM Announcements List (llvm-announce)
- This is a low volume list that provides important announcements regarding LLVM. It gets email about once a month.
A number of regular calls are organized on specific topics. It should be expected that the range of topics will change over time. At the time of writing, the following sync-ups are organized:
| Topic | Frequency | Calendar link | Minutes/docs link |
|---|---|---|---|
| Loop Optimization Working Group | Every 2 weeks on Wednesday | Minutes/docs | |
| RISC-V | Every 2 weeks on Thursday | ics gcal | |
| Scalable Vectors and Arm SVE | Monthly, every 3rd Tuesday | ics gcal | Minutes/docs |
| ML Guided Compiler Optimizations | Monthly | Minutes/docs | |
| LLVM security group | Monthly, every 3rd Tuesday | ics gcal | Minutes/docs |
| CIRCT | Weekly, on Wednesday | Minutes/docs | |
| MLIR design meetings | Weekly, on Thursdays | Minutes/docs | |
| flang | Multiple meeting series, documented here | ||
| OpenMP | Multiple meeting series, documented here | ||
| LLVM Alias Analysis | Every 4 weeks on Tuesdays | ics | Minutes/docs |
| Windows/COFF related developments | Every 2 months on Thursday | Minutes/docs | |
| Vector Predication | Every 2 weeks on Tuesdays, 3pm UTC | Minutes/docs | |
| LLVM Pointer Authentication | Every month on Mondays | ics | Minutes/docs |
| MemorySSA in LLVM | Every 8 weeks on Mondays | ics gcal | Minutes/docs |
| LLVM Embedded Toolchains | Every 4 weeks on Thursdays | ics gcal | Minutes/docs |
Users and developers of the LLVM project (including subprojects such as Clang) can be found in #llvm on irc.oftc.net.
This channel has several bots.
- Buildbot reporters
- llvmbb - Bot for the main LLVM buildbot master. http://lab.llvm.org/buildbot/#/console
- robot - Bugzilla linker. %bug <number>
- clang-bot - A geordi instance running near-trunk clang instead of gcc.
In addition to the traditional IRC there is a Discord chat server available. To sign up, please use this invitation link.
.. toctree:: :hidden: MeetupGuidelines
Besides developer meetings and conferences, there are several user groups called LLVM Socials. We greatly encourage you to join one in your city. Or start a new one if there is none:
Proposals for massive changes in how the community behaves and how the work flow can be better.
.. toctree:: :hidden: CodeOfConduct Proposals/GitHubMove BugpointRedesign Proposals/TestSuite Proposals/VariableNames Proposals/VectorizationPlan Proposals/VectorPredication
- :doc:`CodeOfConduct`
- Proposal to adopt a code of conduct on the LLVM social spaces (lists, events, IRC, etc).
- :doc:`Proposals/GitHubMove`
- Proposal to move from SVN/Git to GitHub.
- :doc:`BugpointRedesign`
- Design doc for a redesign of the Bugpoint tool.
- :doc:`Proposals/TestSuite`
- Proposals for additional benchmarks/programs for llvm's test-suite.
- :doc:`Proposals/VariableNames`
- Proposal to change the variable names coding standard.
- :doc:`Proposals/VectorizationPlan`
- Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
- :doc:`Proposals/VectorPredication`
- Proposal for predicated vector instructions in LLVM.