2019-09-22 04:56:40 +08:00
Getting Involved
================
LLVM welcomes contributions of all kinds. To get started, please review the following topics:
2019-09-25 08:49:02 +08:00
.. contents ::
:local:
2019-09-22 04:56:40 +08:00
.. toctree ::
:hidden:
Contributing
DeveloperPolicy
2020-03-07 12:55:46 +08:00
CodeReview
[docs] Adding a Support Policy
As discussed in the mailing list [1-4], we need a separation of support
tiers when requiring support from the whole community versus a
sub-community. Essentially, if a sub-community is active enough and
takes maintenance into their own internal costs without affecting other
parts of the community's maintenance costs, then code that is not
immediately relevant to all parts (ie. not released, actively tested,
etc) can still find its way into the LLVM main repository without major
pain points.
The main benefit is to reduce the maintenance cost that those
sub-communities have outside of LLVM (for example, in duplicating common
code, applying the same patches on top of multiple user repositories or
downstream projects).
This document outlines the components and responsibilities of the
sub-communities with regards to maintenance costs and how they affect
the rest of the community.
It also adds an addendum on removal policies, which expand the existing
"new target removal" policy into something more generic, to encompass
any piece of code, scripts or documents in the repository.
[1] http://lists.llvm.org/pipermail/llvm-dev/2020-October/146249.html
[2] http://lists.llvm.org/pipermail/llvm-dev/2020-November/146335.html
[3] http://lists.llvm.org/pipermail/llvm-dev/2020-October/146138.html
[4] http://lists.llvm.org/pipermail/llvm-dev/2020-November/146298.html
2020-11-04 21:15:59 +08:00
SupportPolicy
2019-09-22 04:56:40 +08:00
SphinxQuickstartTemplate
Phabricator
HowToSubmitABug
BugLifeCycle
CodingStandards
2022-03-09 07:49:32 +08:00
GitHub
2020-02-11 04:33:20 +08:00
GitBisecting
2021-10-13 23:14:57 +08:00
GitRepositoryPolicy
2019-09-22 04:56:40 +08:00
:doc: `Contributing`
An overview on how to contribute to LLVM.
:doc: `DeveloperPolicy`
The LLVM project's policy towards developers and their contributions.
2020-03-07 12:55:46 +08:00
:doc: `CodeReview`
The LLVM project's code-review process.
[docs] Adding a Support Policy
As discussed in the mailing list [1-4], we need a separation of support
tiers when requiring support from the whole community versus a
sub-community. Essentially, if a sub-community is active enough and
takes maintenance into their own internal costs without affecting other
parts of the community's maintenance costs, then code that is not
immediately relevant to all parts (ie. not released, actively tested,
etc) can still find its way into the LLVM main repository without major
pain points.
The main benefit is to reduce the maintenance cost that those
sub-communities have outside of LLVM (for example, in duplicating common
code, applying the same patches on top of multiple user repositories or
downstream projects).
This document outlines the components and responsibilities of the
sub-communities with regards to maintenance costs and how they affect
the rest of the community.
It also adds an addendum on removal policies, which expand the existing
"new target removal" policy into something more generic, to encompass
any piece of code, scripts or documents in the repository.
[1] http://lists.llvm.org/pipermail/llvm-dev/2020-October/146249.html
[2] http://lists.llvm.org/pipermail/llvm-dev/2020-November/146335.html
[3] http://lists.llvm.org/pipermail/llvm-dev/2020-October/146138.html
[4] http://lists.llvm.org/pipermail/llvm-dev/2020-November/146298.html
2020-11-04 21:15:59 +08:00
:doc: `SupportPolicy`
The LLVM support policy for core and non-core components.
2019-09-22 04:56:40 +08:00
: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.
2022-03-09 07:49:32 +08:00
:doc: `GitHub`
Describes how to use the llvm-project repository on GitHub.
2020-02-11 04:33:20 +08:00
:doc: `GitBisecting`
Describes how to use `` git bisect `` on LLVM's repository.
2021-10-13 23:14:57 +08:00
:doc: `GitRepositoryPolicy`
Collection of policies around the git repositories.
2019-09-22 04:56:40 +08:00
.. _development-process:
Development Process
-------------------
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.
2022-02-22 10:58:48 +08:00
.. _lists-forums:
2019-09-22 04:56:40 +08:00
2022-02-22 10:58:48 +08:00
Forums & Mailing Lists
----------------------
2019-09-22 04:56:40 +08:00
2022-02-22 10:58:48 +08:00
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.
2019-09-22 04:56:40 +08:00
2022-02-22 10:58:48 +08:00
`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.
2019-09-22 04:56:40 +08:00
2022-02-22 10:58:48 +08:00
.. __: https://discourse.llvm.org/
2019-09-22 04:56:40 +08:00
`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.
.. __: http://lists.llvm.org/pipermail/llvm-commits/
`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.
.. __: http://lists.llvm.org/pipermail/llvm-bugs/
2022-02-22 10:58:48 +08:00
`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.
2019-09-22 04:56:40 +08:00
2022-02-22 10:58:48 +08:00
.. __: https://discourse.llvm.org/c/announce/46
2019-09-22 04:56:40 +08:00
[docs] Describe reporting security issues on the chromium tracker.
To track security issues, we're starting with the chromium bug tracker
(using the llvm project there).
We considered using Github Security Advisories. However, they are
currently intended as a way for project owners to publicize their
security advisories, and aren't well-suited to reporting issues.
This also moves the issue-reporting paragraph to the beginning of the
document, in part to make it more discoverable, in part to allow the
anchor-linking to actually display the paragraph at the top of the page.
Note that this doesn't update the concrete list of security-sensitive
areas, which is still an open item. When we do, we may want to move the
list of security-sensitive areas next to the issue-reporting paragraph
as well, as it seems like relevant information needed in the reporting
process.
Finally, when describing the discission medium, this splits the topics
discussed into two: the concrete security issues, discussed in the
issue tracker, and the logistics of the group, in our mailing list,
as patches on public lists, and in the monthly sync-up call.
While there, add a SECURITY.md page linking to the relevant paragraph.
Differential Revision: https://reviews.llvm.org/D100873
2021-04-21 01:31:26 +08:00
.. _online-sync-ups:
2021-03-18 00:55:56 +08:00
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:
.. list-table :: LLVM regular sync-up calls
:widths: 25 25 25 25
:header-rows: 1
* - Topic
- Frequency
- Calendar link
- Minutes/docs link
2021-11-19 05:48:29 +08:00
* - Loop Optimization Working Group
- Every 2 weeks on Wednesday
2022-04-05 09:06:37 +08:00
- `ics <./_static/LoopOptWG_invite.ics> `__
2021-11-19 05:48:29 +08:00
- `Minutes/docs <https://docs.google.com/document/d/1sdzoyB11s0ccTZ3fobqctDpgJmRoFcz0sviKxqczs4g/edit> `__
2021-03-18 00:55:56 +08:00
* - RISC-V
- Every 2 weeks on Thursday
- `ics <https://calendar.google.com/calendar/ical/lowrisc.org_0n5pkesfjcnp0bh5hps1p0bd80%40group.calendar.google.com/public/basic.ics> `__
`gcal <https://calendar.google.com/calendar/b/1?cid=bG93cmlzYy5vcmdfMG41cGtlc2ZqY25wMGJoNWhwczFwMGJkODBAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ> `__
2021-11-15 09:17:08 +08:00
-
2021-03-18 00:55:56 +08:00
* - Scalable Vectors and Arm SVE
- Monthly, every 3rd Tuesday
2021-03-19 17:27:34 +08:00
- `ics <https://calendar.google.com/calendar/ical/bjms39pe6k6bo5egtsp7don414%40group.calendar.google.com/public/basic.ics> `__
`gcal <https://calendar.google.com/calendar/u/0/embed?src=bjms39pe6k6bo5egtsp7don414@group.calendar.google.com> `__
2021-03-18 00:55:56 +08:00
- `Minutes/docs <https://docs.google.com/document/d/1UPH2Hzou5RgGT8XfO39OmVXKEibWPfdYLELSaHr3xzo/edit> `__
* - ML Guided Compiler Optimizations
- Monthly
-
- `Minutes/docs <https://docs.google.com/document/d/1JecbplF09l3swTjze-UVeLh4L48svJxGVy4mz_e9Rhs/edit?usp=gmail#heading=h.ts9cmcjbir1j> `__
* - `LLVM security group <https://llvm.org/docs/Security.html> `__
- Monthly, every 3rd Tuesday
- `ics <https://calendar.google.com/calendar/ical/eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com/public/basic.ics> `__
`gcal <https://calendar.google.com/calendar/embed?src=eoh3m9k1l6vqbd1fkp94fv5q74%40group.calendar.google.com> `__
- `Minutes/docs <https://docs.google.com/document/d/1GLCE8cl7goCaLSiM9j1eIq5IqeXt6_YTY2UEcC4jmsg/edit?usp=sharing> `__
* - `CIRCT <https://github.com/llvm/circt> `__
- Weekly, on Wednesday
2021-11-15 09:17:08 +08:00
-
2021-03-18 00:55:56 +08:00
- `Minutes/docs <https://docs.google.com/document/d/1fOSRdyZR2w75D87yU2Ma9h2-_lEPL4NxvhJGJd-s5pk/edit#heading=h.mulvhjtr8dk9> `__
* - `MLIR <https://mlir.llvm.org> `__ design meetings
- Weekly, on Thursdays
2021-11-15 09:17:08 +08:00
-
2021-03-18 00:55:56 +08:00
- `Minutes/docs <https://docs.google.com/document/d/1y_9f1AbfgcoVdJh4_aM6-BaSHvrHl8zuA5G4jv_94K8/edit#heading=h.cite1kolful9> `__
2021-03-20 16:09:39 +08:00
* - flang
2021-03-18 00:55:56 +08:00
- Multiple meeting series, `documented here <https://github.com/llvm/llvm-project/blob/main/flang/docs/GettingInvolved.md#calls> `__
2021-11-15 09:17:08 +08:00
-
-
2021-03-20 16:09:39 +08:00
* - OpenMP
- Multiple meeting series, `documented here <https://openmp.llvm.org/docs/SupportAndFAQ.html> `__
2021-11-15 09:17:08 +08:00
-
-
2021-03-20 16:09:39 +08:00
* - LLVM Alias Analysis
- Every 4 weeks on Tuesdays
- `ics <http://lists.llvm.org/pipermail/llvm-dev/attachments/20201103/a3499a67/attachment-0001.ics> `__
- `Minutes/docs <https://docs.google.com/document/d/17U-WvX8qyKc3S36YUKr3xfF-GHunWyYowXbxEdpHscw> `__
2021-04-12 23:07:02 +08:00
* - Windows/COFF related developments
- Every 2 months on Thursday
2021-11-15 09:17:08 +08:00
-
2021-04-12 23:07:02 +08:00
- `Minutes/docs <https://docs.google.com/document/d/1A-W0Sas_oHWTEl_x_djZYoRtzAdTONMW_6l1BH9G6Bo/edit?usp=sharing> `__
2021-04-16 16:45:40 +08:00
* - Vector Predication
- Every 2 weeks on Tuesdays, 3pm UTC
-
- `Minutes/docs <https://docs.google.com/document/d/1q26ToudQjnqN5x31zk8zgq_s0lem1-BF8pQmciLa4k8/edit?usp=sharing> `__
2021-04-16 21:10:52 +08:00
* - LLVM Pointer Authentication
- Every month on Mondays
- `ics <https://calendar.google.com/calendar/ical/fr1qtmrmt2s9odufjvurkb6j70%40group.calendar.google.com/public/basic.ics> `__
- `Minutes/docs <https://docs.google.com/document/d/14IDnh3YY9m6Ej_PaRKOz8tTTZlObgtLl8mYeRbytAec/edit?usp=sharing> `__
2021-05-05 02:23:12 +08:00
* - MemorySSA in LLVM
2021-08-02 14:48:25 +08:00
- Every 8 weeks on Mondays
2021-05-05 03:40:49 +08:00
- `ics <https://calendar.google.com/calendar/ical/c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com/public/basic.ics> `__
`gcal <https://calendar.google.com/calendar/embed?src=c_1mincouiltpa24ac14of14lhi4%40group.calendar.google.com> `__
2021-05-05 02:23:12 +08:00
- `Minutes/docs <https://docs.google.com/document/d/1-uEEZfmRdPThZlctOq9eXlmUaSSAAi8oKxhrPY_lpjk/edit#> `__
2022-02-07 21:30:16 +08:00
* - LLVM Embedded Toolchains
- Every 4 weeks on Thursdays
- `ics <https://drive.google.com/file/d/1uNa-PFYkhAfT83kR2Nc4Fi706TAQFBEL/view?usp=sharing> `__
`gcal <https://calendar.google.com/calendar/u/0?cid=ZDQyc3ZlajJmbjIzNG1jaTUybjFsdjA2dWNAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ> `__
- `Minutes/docs <https://docs.google.com/document/d/1GahxppHJ7o1O_fn1Mbidu1DHEg7V2aOr92LXCtNV1_o/edit?usp=sharing> `__
2022-03-09 23:18:35 +08:00
* - Clang C and C++ Language Working Group
2022-03-11 02:08:08 +08:00
- 1st and 3rd Wednesday of the month
2022-03-09 23:18:35 +08:00
- `gcal <https://calendar.google.com/calendar/u/0?cid=cW1lZGg0ZXNpMnIyZDN2aTVydGVrdWF1YzRAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ> `__
- `Minutes/docs <https://docs.google.com/document/d/1x5-RbOC6-jnI_NcJ9Dp4pSmGhhNe7lUevuWUIB46TeM/edit?usp=sharing> `__
2021-03-18 00:55:56 +08:00
2022-02-16 21:53:18 +08:00
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
2022-02-23 21:13:15 +08:00
expertise is. Don't be too shy to dial in!
2022-02-16 21:53:18 +08:00
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.
.. list-table :: LLVM office hours
:widths: 15 40 15 15 15
:header-rows: 1
* - 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
2022-03-24 16:55:32 +08:00
codegen. LLVM security group.
2022-02-16 21:53:18 +08:00
- Every 2nd and 4th Wednesday of the month at 9.30am CET, for 30 minutes.
`ics <https://calendar.google.com/calendar/ical/co0h4ndpvtfe64opn7eraiq3ac%40group.calendar.google.com/public/basic.ics> `__
- `Jitsi <https://meet.jit.si/KristofBeylsLLVMOfficeHour> `__
- English, Flemish, Dutch
2022-02-23 08:38:57 +08:00
* - 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 <https://calendar.google.com/calendar/ical/c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com/public/basic.ics> `__
`gcal <https://calendar.google.com/calendar/embed?src=c_pm6e7160iq7n5fcm1s6m3rjhh4%40group.calendar.google.com> `__
- `GoogleMeet <https://meet.google.com/hhk-xpdj-gvx> `__
- English, Romanian
2022-02-23 21:13:15 +08:00
* - Aaron Ballman
2022-03-09 20:57:30 +08:00
- Clang internals; frontend attributes; clang-tidy; clang-query; AST matchers
- Monthly, 2nd Monday of the month at 10:00am Eastern, for 30 minutes.
2022-02-23 21:13:15 +08:00
`ics <https://calendar.google.com/calendar/ical/npgke5dug0uliud0qapptmps58%40group.calendar.google.com/public/basic.ics> `__
`gcal <https://calendar.google.com/calendar/embed?src=npgke5dug0uliud0qapptmps58%40group.calendar.google.com> `__
- `GoogleMeet <https://meet.google.com/xok-iqne-gmi> `__
- English, Norwegian (not fluently)
2022-03-18 01:48:13 +08:00
* - Johannes Doerfert (he/him)
- OpenMP, LLVM-IR, interprocedural optimizations, Attributor, workshops, research, ...
- Every 2 weeks, Wednesdays 10:30am (Chicago Time), for 1 hour.
`ics <https://outlook.office365.com/owa/calendar/5c93bae7d8fc48f5bd150f9efda8806f@anl.gov/4929bd0f955b4f9b82b7bc995cb3b1bf665030567582422766/S-1-8-2190330107-3188380388-3000953923-1819937831/reachcalendar.ics> `__
- `MS Teams <https://teams.microsoft.com/l/meetup-join/19%3ameeting_MTM2ZDNkNGUtZjg3My00ZDFjLTk5NjctYTIwMmI3MWM4MjFj%40thread.v2/0?context=%7b%22Tid%22%3a%220cfca185-25f7-49e3-8ae7-704d5326e285%22%2c%22Oid%22%3a%220cacfb51-1523-4455-a443-adca936d1af0%22%7d> `__
- English, German
2022-02-16 21:53:18 +08:00
2019-09-22 04:56:40 +08:00
IRC
---
Users and developers of the LLVM project (including subprojects such as Clang)
can be found in #llvm on `irc.oftc.net <irc://irc.oftc.net/llvm> `_ .
This channel has several bots.
* Buildbot reporters
* llvmbb - Bot for the main LLVM buildbot master.
2021-11-18 18:51:47 +08:00
http://lab.llvm.org/buildbot/#/console
2019-09-22 04:56:40 +08:00
* robot - Bugzilla linker. %bug <number>
* clang-bot - A `geordi <http://www.eelis.net/geordi/> `_ instance running
near-trunk clang instead of gcc.
2021-11-15 09:17:08 +08:00
In addition to the traditional IRC there is a
`Discord <https://discord.com/channels/636084430946959380/636725486533345280> `_
chat server available. To sign up, please use this
2021-08-06 15:00:38 +08:00
`invitation link <https://discord.com/invite/xS7Z362> `_ .
2021-11-15 09:17:08 +08:00
2021-08-06 15:00:38 +08:00
2019-09-22 04:56:40 +08:00
.. _meetups-social-events:
Meetups and social events
-------------------------
.. toctree ::
:hidden:
MeetupGuidelines
Besides developer `meetings and conferences <https://llvm.org/devmtg/> `_ ,
there are several user groups called
`LLVM Socials <https://www.meetup.com/pro/llvm/> `_ . We greatly encourage you to
join one in your city. Or start a new one if there is none:
:doc: `MeetupGuidelines`
.. _community-proposals:
Community wide proposals
------------------------
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
[Doc] Proposal for vector predication
Summary:
Proposal and roadmap towards vector predication in LLVM.
This patch documents that
a) It is recognized that current LLVM is ill-equipped for vector predication.
b) The community is working on a solution.
c) A concrete prototype exists in the VP extension (D57504).
Reviewers: rkruppe, rengolin, cameron.mcinally, SjoerdMeijer, andrew.w.kaylor, craig.topper, sdesmalen, k-ishizaka, lattner, fhahn
Reviewed By: andrew.w.kaylor
Subscribers: rogfer01, merge_guards_bot, simoncook, s.egerton, llvm-commits, efocht
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D73889
2020-02-10 17:34:58 +08:00
Proposals/VectorPredication
2019-09-22 04:56:40 +08:00
: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`
[Doc] Proposal for vector predication
Summary:
Proposal and roadmap towards vector predication in LLVM.
This patch documents that
a) It is recognized that current LLVM is ill-equipped for vector predication.
b) The community is working on a solution.
c) A concrete prototype exists in the VP extension (D57504).
Reviewers: rkruppe, rengolin, cameron.mcinally, SjoerdMeijer, andrew.w.kaylor, craig.topper, sdesmalen, k-ishizaka, lattner, fhahn
Reviewed By: andrew.w.kaylor
Subscribers: rogfer01, merge_guards_bot, simoncook, s.egerton, llvm-commits, efocht
Tags: #llvm
Differential Revision: https://reviews.llvm.org/D73889
2020-02-10 17:34:58 +08:00
Proposal to model the process and upgrade the infrastructure of LLVM's Loop Vectorizer.
:doc: `Proposals/VectorPredication`
Proposal for predicated vector instructions in LLVM.