[UpdateCCTestChecks] Detect function mangled name on separate line
[llvm-core.git] / docs / ReportingGuide.rst
blobf7ecbb38d45e40001af862ea9b5a1a25ac7e74fd
1 ===============
2 Reporting Guide
3 ===============
5 .. note::
7    This document is currently a **DRAFT** document while it is being discussed
8    by the community.
10 If you believe someone is violating the :doc:`code of conduct <CodeOfConduct>`
11 you can always report it to the LLVM Foundation Code of Conduct Advisory
12 Committee by emailing conduct@llvm.org. **All reports will be kept
13 confidential.** This isn't a public list and only `members`_ of the advisory
14 committee will receive the report.
16 If you believe anyone is in **physical danger**, please notify appropriate law
17 enforcement first. If you are unsure what law enforcement agency is
18 appropriate, please include this in your report and we will attempt to notify
19 them.
21 If the violation occurs at an event such as a Developer Meeting and requires
22 immediate attention, you can also reach out to any of the event organizers or
23 staff. Event organizers and staff will be prepared to handle the incident and
24 able to help. If you cannot find one of the organizers, the venue staff can
25 locate one for you. We will also post detailed contact information for specific
26 events as part of each events' information. In person reports will still be
27 kept confidential exactly as above, but also feel free to (anonymously if
28 needed) email conduct@llvm.org.
30 .. note::
31    The LLVM community has long handled inappropriate behavior on its own, using
32    both private communication and public responses. Nothing in this document is
33    intended to discourage this self enforcement of community norms. Instead,
34    the mechanisms described here are intended to supplement any self
35    enforcement within the community. They provide avenues for handling severe
36    cases or cases where the reporting party does not wish to respond directly
37    for any reason.
39 Filing a report
40 ===============
42 Reports can be as formal or informal as needed for the situation at hand. If
43 possible, please include as much information as you can. If you feel
44 comfortable, please consider including:
46 * Your contact info (so we can get in touch with you if we need to follow up).
47 * Names (real, nicknames, or pseudonyms) of any individuals involved. If there
48   were other witnesses besides you, please try to include them as well.
49 * When and where the incident occurred. Please be as specific as possible.
50 * Your account of what occurred. If there is a publicly available record (e.g.
51   a mailing list archive or a public IRC logger) please include a link.
52 * Any extra context you believe existed for the incident.
53 * If you believe this incident is ongoing.
54 * Any other information you believe we should have.
56 What happens after you file a report?
57 =====================================
59 You will receive an email from the advisory committee acknowledging receipt
60 within 24 hours (and we will aim to respond much quicker than that).
62 The advisory committee will immediately meet to review the incident and try to
63 determine:
65 * What happened and who was involved.
66 * Whether this event constitutes a code of conduct violation.
67 * Whether this is an ongoing situation, or if there is a threat to anyone's
68   physical safety.
70 If this is determined to be an ongoing incident or a threat to physical safety,
71 the working groups' immediate priority will be to protect everyone involved.
72 This means we may delay an "official" response until we believe that the
73 situation has ended and that everyone is physically safe.
75 The working group will try to contact other parties involved or witnessing the
76 event to gain clarity on what happened and understand any different
77 perspectives.
79 Once the advisory committee has a complete account of the events they will make
80 a decision as to how to respond. Responses may include:
82 * Nothing, if we determine no violation occurred or it has already been
83   appropriately resolved.
84 * Providing either moderation or mediation to ongoing interactions (where
85   appropriate, safe, and desired by both parties).
86 * A private reprimand from the working group to the individuals involved.
87 * An imposed vacation (i.e. asking someone to "take a week off" from a mailing
88   list or IRC).
89 * A public reprimand.
90 * A permanent or temporary ban from some or all LLVM spaces (mailing lists,
91   IRC, etc.)
92 * Involvement of relevant law enforcement if appropriate.
94 If the situation is not resolved within one week, we'll respond within one week
95 to the original reporter with an update and explanation.
97 Once we've determined our response, we will separately contact the original
98 reporter and other individuals to let them know what actions (if any) we'll be
99 taking. We will take into account feedback from the individuals involved on the
100 appropriateness of our response, but we don't guarantee we'll act on it.
102 After any incident, the advisory committee will make a report on the situation
103 to the LLVM Foundation board. The board may choose to make a public statement
104 about the incident. If that's the case, the identities of anyone involved will
105 remain confidential unless instructed by those inviduals otherwise.
107 Appealing
108 =========
110 Only permanent resolutions (such as bans) or requests for public actions may be
111 appealed. To appeal a decision of the working group, contact the LLVM
112 Foundation board at board@llvm.org with your appeal and the board will review
113 the case.
115 In general, it is **not** appropriate to appeal a particular decision on
116 a public mailing list. Doing so would involve disclosure of information which
117 whould be confidential. Disclosing this kind of information publicly may be
118 considered a separate and (potentially) more serious violation of the Code of
119 Conduct. This is not meant to limit discussion of the Code of Conduct, the
120 advisory board itself, or the appropriateness of responses in general, but
121 **please** refrain from mentioning specific facts about cases without the
122 explicit permission of all parties involved.
124 .. _members:
126 Members of the Code of Conduct Advisory Committee
127 =================================================
129 The members serving on the advisory committee are listed here with contact
130 information in case you are more comfortable talking directly to a specific
131 member of the committee.
133 .. note::
135    FIXME: When we form the initial advisory committee, the members names and private contact info need to be added here.
139 (This text is based on the `Django Project`_ Code of Conduct, which is in turn
140 based on wording from the `Speak Up! project`_.)
142 .. _Django Project: https://www.djangoproject.com/conduct/
143 .. _Speak Up! project: http://speakup.io/coc.html