Apache Logo
The Apache Way Contribute ASF Sponsors

Apache Project Management Committees (PMC) are required to report on their project's health and status quarterly to the Board of Directors. While PMCs manage their own technical affairs independently, the Board provides the oversight to ensure that projects continue to operate as healthy, community- and consensus-driven projects that support our mission.

Contents

When & How To Submit Quarterly Board Reports #

The chair of each PMC is responsible for submitting the report for their project on a quarterly basis, at least one week before each board meeting, according to the reporting schedule at

https://svn.apache.org/repos/private/committers/board/committee-info.txt

Reporting late, or outside of that schedule as mentioned below, does not shift this schedule: if you were supposed to report in January for example, but missed that and reported in February, your next report is still due in April.

While in most cases the chair works with other PMC members to write the report, the report is ultimately the chair's responsibility to complete and submit.

Report content must be committed to the monthly board meeting agenda, keeping a similar format to other reports, here:

  https://svn.apache.org/repos/private/foundation/board/

Each report should also be sent in plain-text format to board@apache.org with the prefix [REPORT] and the project name in the subject.

Reports submitted in addition to the regular schedule are also welcomed from any PMC, should they have something notable to report or to request feedback on. In this case, the chair may add the report as an attachment to the end of the agenda and create a corresponding comments section as needed.

While the primary audience for the report is the Board of Directors, remember that reports are made public and provide a chronological history of your project. It is beneficial to write the report with information that you want your community to know now, and in a way that will provide a helpful history for someone looking over the reports in the future.

You may wish to share the public portions of the report with your project community through the users list or project website as well.

Points To Cover In Board Reports

These points are not a template; projects should not simply copy and paste these bullets into their reports. Rather, these are the topics that the Board wants to hear about to be able to evaluate your project's health and status. Not all topics will be pertinent to every report; however the chair should consider all of these questions when writing a report.

Things Not To Put In Reports

Private information

Occasionally a project may need to report something privately to the board, but will not want the information to be published in public minutes.

Such information is welcome in your report, but please include it within <private> and </private> markers, each on separate lines, so we know what to omit from the public minutes.

The next level of privacy, is information that is to be shared only privately with the board members. For that, write directly to board-private@ or a board member who will relay the information to the board.

Other Considerations For Reports

Project reports are the key way to let the board know about the status and health of your project. With the diversity of projects at Apache, these guidelines can't cover all situations. Feel free to include any additional information in your reports that you think is important about your project.

In particular, if there are any "trouble spots" - even potential ones - that the chair or other members of the PMC see in the project, be sure to include a note about them in your board reports.

Finally, if you find yourself with a project that doesn't seem like it has enough activity to create much of a report, then be sure to report that fact. A healthy project should be aware if they are headed for the Apache Attic. Moving to the Attic isn't failure; it's simply recognizing that the project may have matured, drifted off, or has been superceded by other technologies, and we should recognize that fact.

The Board relies on reports from project chairs to be able to understand the status and health of projects. If the Board cannot get a strong feeling about how your project is doing, then we will be contacting you for a follow-up report in the near future.

Engaging with the Board about the Report

Project reports are not necessarily a one-directional form of communication. They are also an opportunity to engage with the Board. Project chairs are welcome to attend the Board meeting as a guest and discuss their report. They may also highlight specific issues that they want the Board to consider (either in the report, or by requesting a broader discussion item for the agenda).

Of course, chairs may also take the opportunity to raise any of these discussions on the Board mailing list at any time, inside or outside of their reporting period.

Each month, a Director will be assigned at random as the "Shepherd" for your project report. They will be responsible for following up your report if it is late, describing the report during the meeting if there are significant comments or a lack of approval, and conveying any followup messages or actions after the meeting.

As Directors review the report in the lead up to the meeting, comments may be added into the agenda alongside your report. Project chairs are encouraged to follow these updates (currently by watching for SVN commits), and respond in advance of the meeting when practical.

The current timeline for a board meeting typically follows this pattern:

  1. Near the beginning of the month, the agenda is created and reminders are sent to projects due to report in the current cycle;
  2. Reports are added to the agenda over the following weeks, up until the due date for the meeting;
  3. Directors will review submitted reports at their convenience, and mark them as "pre-approved" if there are no concerns, sometimes adding comments or requests for more information, or editing the content for obvious corrections;
  4. Shepherds are assigned close to the meeting, and become more familiar with those project reports;
  5. A summary of the reports and any comments is sent to the Board mailing list in the 24 hours prior to the meeting;
  6. During the meeting, the Chairman moves quickly through reports that have received 5 or more "pre-approvals" and have no significant comments;
  7. Reports with significant comments, items for discussion, or a lack of pre-approval will be handed over to the shepherd, who will facilitate discussion and recommend any further action during the meeting;
  8. A summary is sent to all committers after the Board meeting letting them know of the main outcomes;
  9. Any projects that were not approved or missing are added to the reminder list for the subsequent month;
  10. Shepherds will reach out to project chairs with specific action items arising from their reports in the meeting;
  11. Any director comments on your report will be sent to your project's private@ list shortly after the meeting concludes by the Secretary. This gives you brief feedback from the meeting, and a chance to enage with the board either to answer questions or to ask for advice.
  12. Reports are published as part of the minutes, when approved in the subsequent monthly meeting of the Board of Directors.

As you can see, ensuring the report is received on time, includes all necessary details, and has comments addressed greatly enhances the flow of the Board meeting, which needs to cover more than 50 project reports each month, in addition to other business.