-
Notifications
You must be signed in to change notification settings - Fork 2k
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
doxygen: added community processes (import from Wiki) #20496
Merged
dylad
merged 1 commit into
RIOT-OS:master
from
emmanuelsearch:doxygen-community-processes
Mar 21, 2024
+91
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# Community Processes {#community-processes} | ||
|
||
The community around RIOT gathers many IoT developers and users from around | ||
the world, from the industry, from academia, and hobbyists. The RIOT | ||
community is open to everyone. To join and interact, you are invited to: | ||
* join and post to the [forum](https://forum.riot-os.org/), | ||
* post on [GitHub](https://github.com/RIOT-OS/RIOT/pulls), | ||
* connect and post to the [Matrix chat](https://matrix.to/#/#riot-os:matrix.org), | ||
* join virtual or f2f [meetings](https://forum.riot-os.org/c/community/events). | ||
|
||
The community self-organizes using the open processes described below. | ||
|
||
## Contributors | ||
|
||
Code contributions are very welcome. In order to streamline and harmonize code | ||
quality, contributors must follow the [contributing guidelines](https://github.com/RIOT-OS/RIOT/blob/master/CONTRIBUTING.md). | ||
Aside of code contributions, you can also contribute to RIOT on other aspects, | ||
e.g. by actively participating in technical and non-technical discussions within | ||
the community. Regular and interim virtual meetings are announced on the | ||
[forum](https://forum.riot-os.org/c/community/events). | ||
|
||
## Maintainers | ||
|
||
Among contributors, some have maintainer status, which consists in rights (merge rights) | ||
and duties (code review duties). | ||
|
||
Maintainers can propose to give maintainer status to contributors that have been | ||
noticed as particularly active in some domain of RIOT. The decision to grant this | ||
status is then taken via consensus among maintainers. If there is consensus on | ||
granting the status to a particular contributor, a maintainer will contact personally | ||
this contributor to propose the status, which the contributor can then accept | ||
(or turn down). | ||
|
||
We are constantly looking for more maintainers. So if you are up for that, | ||
please start (or continue) contributing code and reviews! | ||
|
||
To contact maintainers, the best is to interact over actual RIOT code on | ||
[GitHub](https://github.com/RIOT-OS/RIOT/pulls). | ||
|
||
## Coordinators | ||
|
||
Among contributors, some are also interested in discussing RIOT matters and | ||
perspectives, beyond coding RIOT. In short, maintainers focus on technical | ||
aspects, while coordinators focus on non-technical aspects of RIOT activity. | ||
Of course, there is a strong overlap between maintainers and coordinators. | ||
|
||
Coordinator status consists essentially in duties (bringing up topics, debates | ||
and deal with the overhead). But sometimes, coordinator status does bring | ||
some moral reward (e.g. when an initiative brings organizational improvements, | ||
in the end ;). | ||
|
||
Coordinators can propose to give coordinator status to contributors that have | ||
been noticed as particularly active in this domain. The decision to grant this | ||
status is then taken via consensus among coordinators. If there is consensus | ||
on granting the status to a particular contributor, a coordinator will contact | ||
personally this contributor to propose the status, which the contributor can | ||
then accept (or turn down). | ||
|
||
To contact coordinators, the best is to email the generic mailing list | ||
riot@riot-os.org | ||
|
||
## Task Forces | ||
|
||
Parts of the community are gathered in *Task Forces*, which provide a specific | ||
venue focusing on a particular technical topic. | ||
|
||
*Task Forces* are (typically short-lived) efforts to achieve a well-defined goal. | ||
This goal might be either designing a concept and/or implementing such a concept | ||
or improving the quality of a certain feature/property of RIOT. | ||
|
||
Each Task Force consists of a small number of RIOT developers and has its own Wiki | ||
page. One or two shepherds are identified per task force as the main contact(s) | ||
for this activity. | ||
|
||
**Creating a new Task Force**. If you wish to launch a new task force, go ahead, | ||
create your wikipage, name your shepherd(s), and signal it on the forum. RIOT | ||
maintainers will contact you in the rare case where duplicate or very closely-related | ||
work has been detected elsewhere, and if joining forces might make sense. | ||
|
||
**Life of a Task Force**. Shepherds and/or participants in a Task Force are invited | ||
to now and then update their wikipage, report progress or summarize the latest stand | ||
of your discussions on the forum. A shepherd-hood may be transferred from one person | ||
to another person if everyone is happy about that. | ||
|
||
**Dissolving an existing Task Force**. Dissolving an existing Task Force happens either | ||
(i) as the shepherd(s) declare the TF has concluded, or declare the TF is abandoned, or | ||
(ii) when the shepherds are unreachable, the TF has been dormant for a long time and | ||
RIOT maintainers declare the TF dissolved. | ||
|
||
More information about (active/concluded/archived) task forces can be found [here](https://github.com/RIOT-OS/RIOT/wiki/Task-Forces). |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question:
Do we want to keep the wiki for this ? Do we have alternative ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree that we should reconsider this. Also the reference to the mailing list.
IMO we should however rather get this in without changes other than typo fixing and do any updates as follow-up PRs. That would IMO make the git history cleaner, if this is basically just an import.