github-mirrors/ibex
1
0
Fork 0
mirror of https://github.com/lowRISC/ibex.git synced 2025-04-22 21:07:34 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

[doc] Add Ibex Concierge documentation

Browse source 
Add a document how we plan to run the Ibex Concierge duty.

Signed-off-by: Philipp Wagner <phw@lowrisc.org>
This commit is contained in:
Philipp Wagner 2020-03-31 14:25:25 +01:00 • committed by Philipp Wagner
parent add91d544d
commit f8aacd15be
2 changed files with 74 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

73
doc/concierge.rst Normal file
View file

@ -0,0 +1,73 @@
.. _concierge:
The Ibex Concierge
==================
.. figure:: https://upload.wikimedia.org/wikipedia/commons/8/80/France_in_XXI_Century._Concierge.jpg
The Ibex Concierge is the friendly caretaker of the Ibex project.
It's a rotating duty shared by experienced contributors to help newcomers find their way around the project, and to stay on top of the various small tasks necessary to keep the project going.
The Ibex CPU project is a reasonably large open source project.
Like all projects we experience two challenges:
we want to lend a helping hand to new developers, answering their questions or helping them with code contributions.
And we need to stay on top of our "caretaker" tasks, like fixing problems with our continuous integration setup, triaging issues and pull requests, etc.
The Ibex Concierge combines these two duties in one person.
Please reach out to the Ibex Concierge if you have trouble finding your way around the Ibex project.
You can find today's Ibex Concierge in the calendar below.
Who is Ibex Concierge today?
----------------------------
The concierge duties rotate between several core developers on a weekly basis.
You can find today's concierge on duty in a `public calendar <https://calendar.google.com/calendar/embed?src=lowrisc.org_s0pdodkddnggdp40jusjij27h4%40group.calendar.google.com>`_.
* Greg Chadwick (`@GregAC <https://github.com/gregac>`_)
* Tom Roberts (`@tomroberts-lowrisc <https://github.com/tomroberts-lowrisc>`_)
* Rupert Swarbrick (`@rswarbrick <https://github.com/rswarbrick>`_)
* Pirmin Vogel (`@vogelpi <https://github.com/vogelpi>`_)
* Philipp Wagner (`@imphil <https://github.com/imphil>`_)
You can be Ibex Concierge, too.
Please talk to any of the current concierges to discuss!
.. raw:: html
<iframe src="https://calendar.google.com/calendar/embed?src=lowrisc.org_s0pdodkddnggdp40jusjij27h4%40group.calendar.google.com" style="border: 0" width="100%" height="600" frameborder="0" scrolling="no"></iframe>
Ibex Concierge duties
---------------------
The Ibex Concierge is aware of what's happening in the Ibex project, and helps to ensure that everyone feels welcome and is able to work productively.
The list of duties includes, but isn't strictly limited to the following tasks.
* Triage incoming issues and pull requests.
* Assign labels to them.
* Give initial feedback with an indication of what the next steps are.
* Answer questions if possible.
* Ask for clarifications where necessary.
* Redirect to the right developers as needed.
* Track progress of open issues and pull requests.
Ensure contributors always know what's going on, and are informed if things take longer.
* Welcome new contributors, and provide (hands-on) help to get them up to speed.
For example, help them get their commits into good shape, etc.
* Fix or coordinate fixes to necessary infrastructure, such as the continuous integration setup in a timely manner.
* Go through the list of open pull requests: ping developers if information or action is needed, close abandoned pull requests, etc.
* Assist with the review and update of open issues.
* At the end of the week, hand over to the next Ibex Concierge on the rota.
Note the obvious: it is not the job of the Ibex Concierge to fix all bugs, implement all incoming feature requests, or be available 24/7.

1
doc/index.rst
View file

@ -24,6 +24,7 @@ Ibex User Manual
rvfi
verification
examples
concierge
.. toctree::