Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Latest commit

 

History

History
421 lines (332 loc) · 17.3 KB

GettingInvolved.rst

File metadata and controls

421 lines (332 loc) · 17.3 KB

Getting Involved

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
   GitHub
   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:`GitHub`
Describes how to use the llvm-project repository on GitHub.
:doc:`GitBisecting`
Describes how to use git bisect on 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 Discourse forums. There are also commit mailing lists for all commits to the LLVM Project. The :doc:`CodeOfConduct` applies to all these forums and mailing lists.

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.

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. The :doc:`CodeOfConduct` applies to all online sync-ups.

If you'd like to organize a new sync-up, please add the info in the table below. Please also create a calendar event for it and invite calendar@llvm.org to the event, so that it'll show up on the :ref:`llvm-community-calendar`.

LLVM regular sync-up calls
Topic Frequency Calendar link Minutes/docs link
Loop Optimization Working Group Every 2 weeks on Wednesday ics 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
Clang C and C++ Language Working Group 1st and 3rd Wednesday of the month gcal Minutes/docs

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!

The :doc:`CodeOfConduct` applies to all office hours.

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.

LLVM office hours
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. LLVM security group. LLVM Office Hours. Every 2nd and 4th Wednesday of the month at 9.30am CET, for 30 minutes. ics Jitsi 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 GoogleMeet 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 GoogleMeet English, Norwegian (not fluently)
Johannes Doerfert (he/him) OpenMP, LLVM-IR, interprocedural optimizations, Attributor, workshops, research, ... Every 2 weeks, Wednesdays 10:30am (Chicago Time), for 1 hour. ics MS Teams English, German
Tobias Grosser General questions on how to contribute to LLVM/MLIR, Polly, Loop Optimization, FPL, Research in LLVM, PhD in CS, Summer of Code. Monthly, last Monday of the month at 18:00 London time (typically 9am PT), for 30 minutes. Video Call English, German, Spanish, French
Anastasia Stulova Clang internals for C/C++ language extensions and dialects, OpenCL, GPU, SPIR-V, how to contribute, women in compilers. Monthly, 2nd Thursday of the month at 17:00 BST - London time (9:00am PT except for 2 weeks in spring), 1 hour slot. GoogleMeet English, Russian, German (not fluently)
Alexey Bader SYCL compiler, offload tools, OpenCL and SPIR-V, how to contribute. Monthly, 2nd Monday of the month at 9:30am PT, for 30 minutes. GoogleMeet English, Russian
Maksim Panchenko BOLT internals, IR, new passes, proposals, etc. Monthly, 2nd Wednesday of the month at 11:00am PT, for 30 minutes. Zoom English, Russian
  • If you're interested in becoming an office hours host, please add your information to the list above. Please create a calendar event for it and invite calendar@llvm.org to the event so that it'll show up on the :ref:`llvm-community-calendar`.

  • When starting an office hours session, consider typing something like "Hi, I'm available for chats in the next half hour at video chat URL. I'm looking forward to having conversations on the video chat or here." on the LLVM chat channels that you are already on. These could include:

    Doing this can help:
    • overcome potential anxiety to call in for a first time,
    • people who prefer to first exchange a few messages through text chat before dialing in, and
    • remind the wider community that office hours do exist.
  • If you decide to no longer host office hours, please do remove your entry from the list above.

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.

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:

:doc:`MeetupGuidelines`

Proposals for massive changes in how the community behaves and how the work flow can be better.

.. toctree::
   :hidden:

   Proposals/GitHubMove
   BugpointRedesign
   Proposals/TestSuite
   Proposals/VariableNames
   Proposals/VectorizationPlan
   Proposals/VectorPredication

: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.

We aim to maintain a public calendar view of all events happening in the LLVM community such as :ref:`online-sync-ups` and :ref:`office-hours`. The calendar can be found at https://calendar.google.com/calendar/u/0/embed?src=calendar@llvm.org and can also be seen inline below: