Getting Involved¶
LLVM welcomes contributions of all kinds. To get started, please review the following topics:
- Contributing to LLVM
An overview on how to contribute to LLVM.
- LLVM Developer Policy
The LLVM project’s policy towards developers and their contributions.
- LLVM Code-Review Policy and Practices
The LLVM project’s code-review process.
- LLVM Community Support Policy
The LLVM support policy for core and non-core components.
- Sphinx Quickstart Template
A template + tutorial for writing new Sphinx documentation. It is meant to be read in source form.
- Code Reviews with Phabricator
Describes how to use the Phabricator code review tool hosted on http://reviews.llvm.org/ and its command line interface, Arcanist.
- How to submit an LLVM bug report
Instructions for properly submitting information about any bugs you run into in the LLVM system.
- LLVM Bug Life Cycle
Describes how bugs are reported, triaged and closed.
- LLVM Coding Standards
Details the LLVM coding standards and provides useful information on writing efficient C++ code.
- LLVM GitHub User Guide
Describes how to use the llvm-project repository on GitHub.
- Bisecting LLVM code
Describes how to use
git bisect
on LLVM’s repository.- Policies on git repositories
Collection of policies around the git repositories.
Development Process¶
Information about LLVM’s development process.
- Creating an LLVM Project
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.- How To Release LLVM To The Public
This is a guide to preparing LLVM releases. Most developers can ignore it.
- How To Validate a New Release
This is a guide to validate a new release, during the release process. Most developers can ignore it.
- How To Add Your Build Configuration To LLVM Buildbot Infrastructure
Instructions for adding new builder to LLVM buildbot master.
- Advice on Packaging LLVM
Advice on packaging LLVM into a distribution.
- Release notes for the current release
This describes new features, known bugs, and other limitations.
Forums & Mailing Lists¶
If you can’t find what you need in these docs, try consulting the Discourse forums. There are also commit mailing lists for all commits to the LLVM Project.
- LLVM Discourse
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.
- 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.
- LLVM Announcements
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.
Online Sync-Ups¶
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 |
||
RISC-V |
Every 2 weeks on Thursday |
||
Scalable Vectors and Arm SVE |
Monthly, every 3rd Tuesday |
||
ML Guided Compiler Optimizations |
Monthly |
||
Monthly, every 3rd Tuesday |
|||
Weekly, on Wednesday |
|||
MLIR design meetings |
Weekly, on Thursdays |
||
flang |
Multiple meeting series, documented here |
||
OpenMP |
Multiple meeting series, documented here |
||
LLVM Alias Analysis |
Every 4 weeks on Tuesdays |
||
Windows/COFF related developments |
Every 2 months on Thursday |
||
Vector Predication |
Every 2 weeks on Tuesdays, 3pm UTC |
||
LLVM Pointer Authentication |
Every month on Mondays |
||
MemorySSA in LLVM |
Every 8 weeks on Mondays |
||
LLVM Embedded Toolchains |
Every 4 weeks on Thursdays |
||
Clang C and C++ Language Working Group |
Every 2 weeks on Wednesday |
Office hours¶
A number of experienced LLVM contributors make themselves available for a chat on a regular schedule, to anyone who is looking for some guidance. Please find the list of who is available when, through which medium, and what their area of expertise is. Don’t be too shy to dial in!
Of course, people take time off from time to time, so if you dial in and you don’t find anyone present, chances are they happen to be off that day.
Name |
In-scope topics |
When? |
Where? |
Languages |
---|---|---|---|---|
Kristof Beyls |
General questions on how to contribute to LLVM; organizing meetups; submitting talks; and other general LLVM-related topics. Arm/AArch64 codegen. |
Every 2nd and 4th Wednesday of the month at 9.30am CET, for 30 minutes. ics |
English, Flemish, Dutch |
|
Alina Sbirlea |
General questions on how to contribute to LLVM; women in compilers; MemorySSA, BatchAA, various loop passes, new pass manager. |
Monthly, 2nd Tuesdays, 10.00am PT/7:00pm CET, for 30 minutes. ics gcal |
English, Romanian |
|
Aaron Ballman |
Clang internals; frontend attributes; clang-tidy; clang-query; AST matchers |
Monthly, 2nd Monday of the month at 10:00am Eastern, for 30 minutes. ics gcal |
English, Norwegian (not fluently) |
IRC¶
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.
Community wide proposals¶
Proposals for massive changes in how the community behaves and how the work flow can be better.
- LLVM Community Code of Conduct
Proposal to adopt a code of conduct on the LLVM social spaces (lists, events, IRC, etc).
- Moving LLVM Projects to GitHub
Proposal to move from SVN/Git to GitHub.
- Bugpoint Redesign
Design doc for a redesign of the Bugpoint tool.
- Test-Suite Extensions
Proposals for additional benchmarks/programs for llvm’s test-suite.
- Variable Names Plan
Proposal to change the variable names coding standard.
- Vectorization Plan
Proposal to model the process and upgrade the infrastructure of LLVM’s Loop Vectorizer.
- Vector Predication Roadmap
Proposal for predicated vector instructions in LLVM.