kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-15 01:23:49 +01:00
Code Releases Activity

doc/guides: migrate code of conduct

Browse Source 
Co-authored-by: crasbe <crasbe@gmail.com>
This commit is contained in:
AnnsAnn 2025-09-17 17:50:35 +02:00
parent 10488f73b9
commit a8f0c8afab
5 changed files with 167 additions and 159 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
doc/doxygen/src/coc-faq.md
View File

@ -1,75 +1,4 @@
# FAQ {#coc-faq} # FAQ (Deprecated) {#coc-faq}
This FAQ attempts to address common questions and concerns around the RIOT @deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/faq/).
community's [Code of Conduct][CoC]. If you still have questions after This page will be removed after release 2026.04.
reading it, please feel free to [contact us][CoC-question-mail].
--------------------------------------------------------------------------------
### Why have you adopted a Code of Conduct?
If you're familiar with the RIOT
community, you'll probably notice that the Code basically matches what we
already do. Think of this as documentation: we're taking implicit expectations
about behavior and making them explicit.
We're doing this because the RIOT community is growing faster than any of us
could have anticipated. This is on balance a very positive thing, but as we've
grown past the point where it's possible to know the whole community we think
it's very important to be clear about our values.
We know that the RIOT community is open, friendly, and welcoming. We want to
make sure everyone else knows it too.
### What does it mean to "adopt" a Code of Conduct?
For the most part, we don't think it means large changes. We think that the text
does a really good job describing the way the RIOT community already conducts
itself. We expect that most people will simply continue to behave in the awesome
way they have for years.
However, we do expect that people will abide by the spirit and words of the CoC
when in "official" RIOT spaces. This code has been adopted by the RIOT community
as a whole. That means that it'll apply in all community spaces.
In practice, this means the [RIOT forum](https://forum.riot-os.org), the Matrix
chats (e.g., [`#riot-os`](https://matrix.to/#/#riot-os:matrix.org) or
[`#riot-os-off-topic`](https://matrix.to/#/#riot-os-off-topic:matrix.org)),
mailing lists (e.g., security@riot-os.org), bug tracking and code review tools,
and "official" RIOT events such as Hack'n'ACKs or RIOT summits. In addition,
violations of this code outside these spaces may affect a person's ability to
participate within them.
### What happens if someone violates the Code of Conduct?
Our intent is that anyone in the community can stand up for this code, and
direct people who're unaware to this document. If that doesn't work, or if you
need more help, you can contact <conduct@riot-os.org>. For more details please see
our [Reporting Guidelines](@ref coc-reporting-guide).
### Why do we need a Code of Conduct? Everyone knows not to be a jerk.
Sadly, not everyone knows this.
However, even if everyone was kind, everyone was compassionate, and everyone was
familiar with codes of conduct it would still be incumbent upon our community to
publish our own. Maintaining a code of conduct forces us to consider and
articulate what kind of community we want to be, and serves as a constant
reminder to put our best foot forward. But most importantly, it serves as a
signpost to people looking to join our community that we feel these values are
important.
### This is censorship! I have the right to say whatever I want!
You do -- in *your* space. If you'd like to hang out in *our* spaces (as
clarified above), we have some simple guidelines to follow. If you want to, for
example, form a group where RIOT is discussed using language inappropriate for
general channels then nobody's stopping you. We respect your right to establish
whatever codes of conduct you want in the spaces that belong to you. Please
honor this Code of Conduct in our spaces.
#### References
This FAQ was adapted from the [Django Code of Conduct FAQ](https://www.djangoproject.com/conduct/faq/)
[CoC-question-mail]: mailto:riot@riot-os.org
[CoC]: @ref coc

9
doc/doxygen/src/coc-info.md
View File

@ -1,8 +1,5 @@
Code of Conduct Information {#coc-info} Code of Conduct Information (Deprecated) {#coc-info}
=========================== ===========================
The following documents are describing all matters around our code of conduct: @deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/).
This page will be removed after release 2026.04.
- The \subpage coc itself,
- The \subpage coc-reporting-guide, and
- The \subpage coc-faq

82
doc/doxygen/src/coc-reporting-guide.md
View File

@ -1,80 +1,4 @@
# Reporting Guidelines {#coc-reporting-guide} # Reporting Guidelines (Deprecated) {#coc-reporting-guide}
If you believe someone is violating the [code of conduct][CoC] we ask that you @deprecated Guides have moved to the [Guide Site](https://guide.riot-os.org/general/code_of_conduct/reporting/).
report it to us by emailing <conduct@riot-os.org>. Currently, the recipients of This page will be removed after release 2026.04.
this email address are [\@OlegHahm](https://github.com/OlegHahm) (Oleg Hahm) and
[\@miri64](https://github.com/miri64) (Martine Lenders).
**All reports will be kept confidential.** In some cases we may determine that a
public statement will need to be made. If that's the case, the identities of all
victims and reporters will remain confidential unless those individuals instruct
us otherwise.
**If you believe anyone is in physical danger, please notify appropriate law
enforcement first.** If you are unsure what law enforcement agency is
appropriate, please include this in your report and we will attempt to notify
them.
If you are unsure whether the incident is a violation, or whether the space
where it happened is covered by this Code of Conduct, we encourage you to still
report it. We would much rather have a few extra reports where we decide to take
no action, rather than miss a report of an actual violation. We do not look
negatively on you if we find the incident is not a violation. And knowing about
incidents that are not violations, or happen outside our spaces, can also help
us to improve the Code of Conduct or the processes surrounding it.
In your report please include:
- Your contact info (so we can get in touch with you if we need to follow up)
- Names (real, nicknames, or pseudonyms) of any individuals involved. If there
were other witnesses besides you, please try to include them as well.
- When and where the incident occurred. Please be as specific as possible.
- Your account of what occurred. If there is a publicly available record (e.g.
forum post, a mailing list archive, or a public Matrix chat link) please include a link.
- Any extra context you believe existed for the incident.
- If you believe this incident is ongoing.
- Any other information you believe we should have.
### What happens after you file a report?
You will receive an email from one of the core community members as soon as
possible. We promise to acknowledge receipt within 24 hours (and will aim for
much quicker than that).
They will review the incident and determine:
- What happened.
- Whether this event constitutes a code of conduct violation.
- Who the bad actor was.
- Whether this is an ongoing situation, or if there is a threat to anyone's
physical safety.
If this is determined to be an ongoing incident or a threat to physical safety,
their immediate priority will be to protect everyone involved.
This means we may delay an "official" response until we believe that the
situation has ended and that everyone is physically safe.
Once the working group has a complete account of the events they will make a
decision as to how to response. Responses may include:
- Nothing (if we determine no violation occurred).
- A private reprimand from us to the individual(s) involved.
- A public reprimand.
- An imposed vacation (i.e. asking someone to "take a week off" from the forum, the Matrix chats, or a mailing
list).
- A permanent or temporary ban from some or all RIOT spaces (forum, Matrix chats, mailing lists,
etc.)
- A request for a public or private apology.
We'll respond within one week to the person who filed the report with either a
resolution or an explanation of why the situation is not yet resolved.
Once we've determined our final action, we'll contact the original reporter to
let them know what action (if any) we'll be taking. We'll take into account
feedback from the reporter on the appropriateness of our response, but we don't
guarantee we'll act on it.
#### Reference
These reporting guidelines were adapted from the [Django reporting guidelines](https://www.djangoproject.com/conduct/reporting/)
[CoC]: @ref coc

76
doc/guides/general/code_of_conduct/faq.md Normal file
View File

@ -0,0 +1,76 @@
---
title: FAQ
description: Frequently Asked Questions about the RIOT Code of Conduct
---
This FAQ attempts to address common questions and concerns around the RIOT
community's [Code of Conduct](/general/code_of_conduct/).
If you still have questions after reading it,
please feel free to [contact us](mailto:riot@riot-os.org).
--------------------------------------------------------------------------------
### Why have you adopted a Code of Conduct?
If you're familiar with the RIOT
community, you'll probably notice that the Code basically matches what we
already do. Think of this as documentation: we're taking implicit expectations
about behavior and making them explicit.
We're doing this because the RIOT community is growing faster than any of us
could have anticipated. This is on balance a very positive thing, but as we've
grown past the point where it's possible to know the whole community we think
it's very important to be clear about our values.
We know that the RIOT community is open, friendly, and welcoming. We want to
make sure everyone else knows it too.
### What does it mean to "adopt" a Code of Conduct?
For the most part, we don't think it means large changes. We think that the text
does a really good job describing the way the RIOT community already conducts
itself. We expect that most people will simply continue to behave in the awesome
way they have for years.
However, we do expect that people will abide by the spirit and words of the CoC
when in "official" RIOT spaces. This code has been adopted by the RIOT community
as a whole. That means that it'll apply in all community spaces.
In practice, this means the [RIOT forum](https://forum.riot-os.org), the Matrix
chats (e.g., [`#riot-os`](https://matrix.to/#/#riot-os:matrix.org) or
[`#riot-os-off-topic`](https://matrix.to/#/#riot-os-off-topic:matrix.org)),
mailing lists (e.g., security@riot-os.org), bug tracking and code review tools,
and "official" RIOT events such as Hack'n'ACKs or RIOT summits. In addition,
violations of this code outside these spaces may affect a person's ability to
participate within them.
### What happens if someone violates the Code of Conduct?
Our intent is that anyone in the community can stand up for this code, and
direct people who're unaware to this document. If that doesn't work, or if you
need more help, you can contact <conduct@riot-os.org>. For more details please see
our [Reporting Guidelines](/general/code_of_conduct/reporting/).
### Why do we need a Code of Conduct? Everyone knows not to be a jerk.
Sadly, not everyone knows this.
However, even if everyone was kind, everyone was compassionate, and everyone was
familiar with codes of conduct it would still be incumbent upon our community to
publish our own. Maintaining a code of conduct forces us to consider and
articulate what kind of community we want to be, and serves as a constant
reminder to put our best foot forward. But most importantly, it serves as a
signpost to people looking to join our community that we feel these values are
important.
### This is censorship! I have the right to say whatever I want!
You do -- in *your* space. If you'd like to hang out in *our* spaces (as
clarified above), we have some simple guidelines to follow. If you want to, for
example, form a group where RIOT is discussed using language inappropriate for
general channels then nobody's stopping you. We respect your right to establish
whatever codes of conduct you want in the spaces that belong to you. Please
honor this Code of Conduct in our spaces.
#### References
This FAQ was adapted from the [Django Code of Conduct FAQ](https://www.djangoproject.com/conduct/faq/)

82
doc/guides/general/code_of_conduct/reporting.md Normal file
View File

@ -0,0 +1,82 @@
---
title: Reporting Guidelines
description: How to report violations of the RIOT Code of Conduct
---
If you believe someone is violating the [code of conduct](/general/code_of_conduct/)
we ask that you report it to us by emailing <conduct@riot-os.org>.
Currently, the recipients of
this email address are [\@OlegHahm](https://github.com/OlegHahm) (Oleg Hahm) and
[\@miri64](https://github.com/miri64) (Martine Lenders).
**All reports will be kept confidential.** In some cases we may determine that a
public statement will need to be made. If that's the case, the identities of all
victims and reporters will remain confidential unless those individuals instruct
us otherwise.
**If you believe anyone is in physical danger, please notify appropriate law
enforcement first.** If you are unsure what law enforcement agency is
appropriate, please include this in your report and we will attempt to notify
them.
If you are unsure whether the incident is a violation, or whether the space
where it happened is covered by this Code of Conduct, we encourage you to still
report it. We would much rather have a few extra reports where we decide to take
no action, rather than miss a report of an actual violation. We do not look
negatively on you if we find the incident is not a violation. And knowing about
incidents that are not violations, or happen outside our spaces, can also help
us to improve the Code of Conduct or the processes surrounding it.
In your report please include:
- Your contact info (so we can get in touch with you if we need to follow up)
- Names (real, nicknames, or pseudonyms) of any individuals involved. If there
were other witnesses besides you, please try to include them as well.
- When and where the incident occurred. Please be as specific as possible.
- Your account of what occurred. If there is a publicly available record (e.g.
forum post, a mailing list archive, or a public Matrix chat link) please include a link.
- Any extra context you believe existed for the incident.
- If you believe this incident is ongoing.
- Any other information you believe we should have.
### What happens after you file a report?
You will receive an email from one of the core community members as soon as
possible. We promise to acknowledge receipt within 24 hours (and will aim for
much quicker than that).
They will review the incident and determine:
- What happened.
- Whether this event constitutes a code of conduct violation.
- Who the bad actor was.
- Whether this is an ongoing situation, or if there is a threat to anyone's
physical safety.
If this is determined to be an ongoing incident or a threat to physical safety,
their immediate priority will be to protect everyone involved.
This means we may delay an "official" response until we believe that the
situation has ended and that everyone is physically safe.
Once the working group has a complete account of the events they will make a
decision as to how to response. Responses may include:
- Nothing (if we determine no violation occurred).
- A private reprimand from us to the individual(s) involved.
- A public reprimand.
- An imposed vacation (i.e. asking someone to "take a week off" from the forum,
the Matrix chats, or a mailing list).
- A permanent or temporary ban from some or all RIOT spaces (forum, Matrix chats, mailing lists,
etc.)
- A request for a public or private apology.
We'll respond within one week to the person who filed the report with either a
resolution or an explanation of why the situation is not yet resolved.
Once we've determined our final action, we'll contact the original reporter to
let them know what action (if any) we'll be taking. We'll take into account
feedback from the reporter on the appropriateness of our response, but we don't
guarantee we'll act on it.
#### Reference
These reporting guidelines were adapted from the [Django reporting guidelines](https://www.djangoproject.com/conduct/reporting/)