You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by su...@apache.org on 2023/12/04 06:07:49 UTC

(incubator-opendal) 01/01: docs(website): show maturity model

This is an automated email from the ASF dual-hosted git repository.

suyanhanx pushed a commit to branch show-maturity
in repository https://gitbox.apache.org/repos/asf/incubator-opendal.git

commit 8c53a3c3b20c985f19bdf40ea5afdf9de0c6e6c0
Author: suyanhanx <su...@gmail.com>
AuthorDate: Mon Dec 4 14:05:51 2023 +0800

    docs(website): show maturity model
    
    Signed-off-by: suyanhanx <su...@gmail.com>
---
 CONTRIBUTING.md                     | 13 +++++++++++--
 website/community/index.mdx         | 17 +++++++++++++++++
 website/{ => community}/maturity.md | 20 ++++++++++++--------
 3 files changed, 40 insertions(+), 10 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 602d04dca..e222cf6f7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -53,7 +53,12 @@ All pull requests should be reviewed by at least one OpenDAL committer.
 
 #### Merge Style
 
-All pull requests are squash merged. We generally discourage large pull requests that are over 300-500 lines of diff. If you would like to propose a change that is larger we suggest coming onto our [Discussions](https://github.com/apache/incubator-opendal/discussions) and discuss it with us. This way we can talk through the solution and discuss if a change that large is even needed! This will produce a quicker response to the change and likely produce code that aligns better with our process.
+All pull requests are squash merged.
+We generally discourage large pull requests that are over 300–500 lines of diff.
+If you would like to propose a change that is larger, we suggest
+coming onto our [Discussions](https://github.com/apache/incubator-opendal/discussions) and discussing it with us.
+This way we can talk through the solution and discuss if a change that large is even needed!
+This will produce a quicker response to the change and likely produce code that aligns better with our process.
 
 ### CI
 
@@ -65,7 +70,11 @@ For small or first-time contributions, we recommend the dev container method. Pr
 
 ### Using a dev container environment
 
-OpenDAL provides a pre-configured [dev container](https://containers.dev/) that could be used in [GitHub Codespaces](https://github.com/features/codespaces), [VSCode](https://code.visualstudio.com/), [JetBrains](https://www.jetbrains.com/remote-development/gateway/), [JuptyerLab](https://jupyterlab.readthedocs.io/en/stable/). Please pick up your favourite runtime environment.
+OpenDAL provides a pre-configured [dev container](https://containers.dev/)
+that could be used in [GitHub Codespaces](https://github.com/features/codespaces),
+[VSCode](https://code.visualstudio.com/), [JetBrains](https://www.jetbrains.com/remote-development/gateway/),
+[JupyterLab](https://jupyterlab.readthedocs.io/en/stable/).
+Please pick up your favourite runtime environment.
 
 The fastest way is:
 
diff --git a/website/community/index.mdx b/website/community/index.mdx
index 161675947..d94f261b0 100644
--- a/website/community/index.mdx
+++ b/website/community/index.mdx
@@ -65,8 +65,25 @@ Enhancements or new feature proposals are also welcome. The more concrete and ra
 * OpenDAL core repository: https://github.com/apache/incubator-opendal
 
 ## People
+
+Thank you to all the contributors for your selfless dedication and expertise
+in making this project more comprehensive and valuable.
+We sincerely appreciate your support and efforts!
+
+### Committers
+
 The list below could be outdated. Please find the most up-to-date list [here](https://people.apache.org/phonebook.html?podling=opendal).
 
+This list of committers is sorted alphabetically by Apache ID.
+And bolded names are PPMC members.
+
 import Committers from "../src/components/Committers"
 
 <Committers/>
+
+### Contributors
+
+The contributor list could be found [here](https://github.com/apache/incubator-opendal/graphs/contributors/).
+
+
+
diff --git a/website/maturity.md b/website/community/maturity.md
similarity index 97%
rename from website/maturity.md
rename to website/community/maturity.md
index 6d9d754ca..ed34fb01a 100644
--- a/website/maturity.md
+++ b/website/community/maturity.md
@@ -1,3 +1,7 @@
+---
+title: Maturity
+---
+
 # Maturity Assessment for Apache OpenDAL
 
 The goals of this maturity model are to describe how Apache projects operate in a concise and high-level way, and to provide a basic framework that projects may choose to use to evaluate themselves.
@@ -14,13 +18,13 @@ The following table is filled according to the [Apache Maturity Model](https://c
 
 ### CODE
 
-| **ID**   | **Description**                                                                                                                                                                                                                                                | **Status**                                                                                                                                                                                                          |
-|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **CD10** | The project produces Open Source software for distribution to the public, at no charge.                                                                                                                                                                        | **YES** The project source code is licensed under the `Apache License 2.0`.                                                                                                                                         |
-| **CD20** | Anyone can easily discover and access the project's code..                                                                                                                                                                                                     | **YES** The [official website](https://opendal.apache.org/) includes `GitHub` link which can access the project's repository on GitHub directly.                                                                    |
-| **CD30** | Anyone using standard, widely-available tools, can build the code in a reproducible way.                                                                                                                                                                       | **YES**  Apache OpenDAL provide `how-to-build` document for every component to tell user how to compile on bare metal, such as the [core's](../core/CONTRIBUTING.md).                                               |
-| **CD40** | The full history of the project's code is available via a source code control system, in a way that allows anyone to recreate any released version.                                                                                                            | **YES** It depends on git, and anyone can view the full history of the project via commit logs.                                                                                                                     |
-| **CD50** | The source code control system establishes the provenance of each line of code in a reliable way, based on strong authentication of the committer. When third parties contribute code, commit messages provide reliable information about the code provenance. | **YES** The project uses GitHub and managed by Apache Infra, it ensuring provenance of each line of code to a committer. And the third-party contributions are accepted in accordance with the contributing guides. |
+| **ID**   | **Description**                                                                                                                                                                                                                                                | **Status**                                                                                                                                                                                                               |
+|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **CD10** | The project produces Open Source software for distribution to the public, at no charge.                                                                                                                                                                        | **YES** The project source code is licensed under the `Apache License 2.0`.                                                                                                                                              |
+| **CD20** | Anyone can easily discover and access the project's code..                                                                                                                                                                                                     | **YES** The [official website](https://opendal.apache.org/) includes `GitHub` link which can access the project's repository on GitHub directly.                                                                         |
+| **CD30** | Anyone using standard, widely-available tools, can build the code in a reproducible way.                                                                                                                                                                       | **YES**  Apache OpenDAL provide `how-to-build` document for every component to tell user how to compile on bare metal, such as the [core's](https://github.com/apache/incubator-opendal/blob/main/core/CONTRIBUTING.md). |
+| **CD40** | The full history of the project's code is available via a source code control system, in a way that allows anyone to recreate any released version.                                                                                                            | **YES** It depends on git, and anyone can view the full history of the project via commit logs.                                                                                                                          |
+| **CD50** | The source code control system establishes the provenance of each line of code in a reliable way, based on strong authentication of the committer. When third parties contribute code, commit messages provide reliable information about the code provenance. | **YES** The project uses GitHub and managed by Apache Infra, it ensuring provenance of each line of code to a committer. And the third-party contributions are accepted in accordance with the contributing guides.      |
 
 ### LICENSE
 
@@ -57,7 +61,7 @@ The following table is filled according to the [Apache Maturity Model](https://c
 | **ID**   | **Description**                                                                                                                                                        | **Status**                                                                                                                                                                                                                |
 |----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **CO10** | The project has a well-known homepage that points to all the information required to operate according to this maturity model.                                         | **YES** The [official website](https://opendal.apache.org/) includes all information user need to run Apache OpenDAL.                                                                                                     |
-| **CO20** | The community welcomes contributions from anyone who acts in good faith and in a respectful manner, and who adds value to the project.                                 | **Yes** We provide contributing guides for every component. And we also have a [general contributing guide](../CONTRIBUTING.md)                                                                                           |
+| **CO20** | The community welcomes contributions from anyone who acts in good faith and in a respectful manner, and who adds value to the project.                                 | **Yes** We provide contributing guides for every component. And we also have a [general contributing guide](https://github.com/apache/incubator-opendal/blob/main/CONTRIBUTING.md)                                        |
 | **CO30** | Contributions include source code, documentation, constructive bug reports, constructive discussions, marketing and generally anything that adds value to the project. | **YES** All good contributions including code and non-code are welcomed.                                                                                                                                                  |
 | **CO40** | The community strives to be meritocratic and gives more rights and responsibilities to contributors who, over time, add value to the project.                          | **YES** The community has elected 2 new PPMC members and 7 new committers so far.                                                                                                                                         |
 | **CO50** | The project documents how contributors can earn more rights such as commit access or decision power, and applies these principles consistently.                        | **No** Waiting for this [issue](https://github.com/apache/incubator-opendal/issues/3705) addressed.                                                                                                                       |