This is an automated email from the ASF dual-hosted git repository.
xuanwo pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git
The following commit(s) were added to refs/heads/main by this push:
new 8e5f3bb67 docs(contributing): add podling status report guide (#2996)
8e5f3bb67 is described below
commit 8e5f3bb677d51025f690671b605f98237ec7d9bb
Author: Chojan Shang <[email protected]>
AuthorDate: Sat Sep 2 10:05:19 2023 +0800
docs(contributing): add podling status report guide (#2996)
* docs(contributing): add podling status report guide
Signed-off-by: Chojan Shang <[email protected]>
* docs(contributing): add announce header
Signed-off-by: Chojan Shang <[email protected]>
* docs: apply suggestions from code review
Co-authored-by: tison <[email protected]>
---------
Signed-off-by: Chojan Shang <[email protected]>
Co-authored-by: tison <[email protected]>
---
website/docs/contributing/podling-report.md | 56 +++++++++++++++++++++++++++++
1 file changed, 56 insertions(+)
diff --git a/website/docs/contributing/podling-report.md
b/website/docs/contributing/podling-report.md
new file mode 100644
index 000000000..723fc30f5
--- /dev/null
+++ b/website/docs/contributing/podling-report.md
@@ -0,0 +1,56 @@
+---
+title: Podling Status Reports
+sidebar_position: 4
+---
+
+Podling Status Report provides key updates on your podling's status and helps
the ASF Board monitor and support the incubating projects. This guide provides
step-by-step instructions on how to prepare and submit Podling Status Report
effectively.
+
+### Frequency of Reporting
+
+New podlings are required to submit reports monthly for the first three
months. After this period, the reporting frequency changes to quarterly.
+
+**The current reporting frequency for OpenDAL is once per quarter.** Stay
attentive to [email protected]
([subscribe](mailto:[email protected])), where due dates
for these reports are announced.
+
+### Report Preparation
+
+It's recommended to discuss the report on [email protected]
([subscribe](mailto:[email protected])), inviting all members to
contribute. Here are the critical points your report should address:
+
+- Any concerns that require the attention of the Incubator PMC or ASF Board.
+- Legal, infrastructure, cross-project, or personal issues that need
addressing.
+- Achievements (releases, milestones, etc.) since the last report.
+- The activity and helpfulness of mentors.
+- Any other significant points or thoughts you think should be included.
+
+You can discuss the issues based on the template or refer to [previous
reports](https://cwiki.apache.org/confluence/display/INCUBATOR/August2023#opendal)
for preparation.
+
+### Report Writing and Submission
+
+Podling Status Report has its own format. Please fill it out based on your
assessment of the project's incubation status and the materials collected
during the preparation phase. We should use the existing format and don’t
change the subject headers.
+
+:::note
+
+Note that IPMC update the template from time to time, so be sure to use the
one IPMC provide and not a previous report.
+
+:::
+
+### Mentor Sign-off
+
+Each Podling Status Report must be signed off by a mentor. **Without a
mentor's sign-off, the IPMC will not accept the report**, and the podling will
need to submit a new report the following month.
+
+After submitting the report, you can send a email to [email protected]
to remind our mentors and the community to review the report and provide
feedback.
+
+```
+[ANNOUNCE] OpenDAL's Podling Report of <Month><Year>
+
+Hello, everyone!
+
+As a representative of the OpenDAL community, I am pleased to present our
<Month><Year> podling report.
+
+We appreciate the opportunity to share updates on our progress and
+achievements over the past weeks, and we welcome any feedback or
+suggestions that may help us continue to grow and succeed as a project.
+
+Thank you for your continued support.
+
+LINK: <link-of-report-in-cwiki>
+```
