From 5a6add96d8f8a181cb8e107879b92e18715265a0 Mon Sep 17 00:00:00 2001 From: Mahfuza Date: Sun, 20 Aug 2023 10:46:03 +0600 Subject: [PATCH 1/7] improve community section Signed-off-by: Mahfuza --- docs/contribute/contribute.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/contribute/contribute.md b/docs/contribute/contribute.md index 67f3debc..e0dff56a 100644 --- a/docs/contribute/contribute.md +++ b/docs/contribute/contribute.md @@ -27,7 +27,7 @@ If you split your pull request into small changes, please make sure any of the c ### Fork and Clone the Repository -Fork [the WasmEdge repository](https://github.com/WasmEdge/WasmEdge) and clone the code to your local workspace +Fork [the WasmEdge repository](https://github.com/WasmEdge/WasmEdge) and clone the code to your local workspace. ### Branches and Commits @@ -50,8 +50,18 @@ LD_LIBRARY_PATH=$(pwd)/lib/api ctest When ready for review, push your branch to your fork repository on github. +Please sign your commits before sending a PR. To sign off on a commit, you just add a line at the end of your commit message with your signature like: + +```bash +Signed-off-by: Sarrah Bastawala +``` + +This can be automatically added to your commit message by passing -s or --signoff to git commit. + Then visit your fork at and click the `Compare & Pull Request` button next to your branch to create a new pull request. Description of a pull request should refer to all the issues that it addresses. Remember to put a reference to issues (such as Closes #XXX and Fixes #XXX) in the comment so that the issues can be closed when the PR is merged. After creating a pull request, please check that the CI passes with your code changes. +After creating a pull request, please ensure that the CI passes with your code and documentation changes. + Once your pull request has been opened it will be assigned to one or more reviewers. Those reviewers will do a thorough code review, looking for correctness, bugs, opportunities for improvement, documentation and comments, and coding style. Commit changes made in response to review comments to the same branch on your fork. @@ -78,3 +88,7 @@ Update the documentation if you are creating or changing features. Good document You can propose new designs for existing WasmEdge features. You can also design entirely new features, please submit a proposal via the GitHub issues. WasmEdge maintainers will review this proposal as soon as possible. This is necessary to ensure the overall architecture is consistent and to avoid duplicated work in the roadmap. + +## Code of Conduct + +We value the participation and collaboration of every member of our community. Therefore, we require all participants to adhere to our [Code of Conduct](https://github.com/WasmEdge/WasmEdge/blob/master/docs/CODE_OF_CONDUCT.md). From 759e0bde7e1df8b454c1cdf73d7746a97cedb09a Mon Sep 17 00:00:00 2001 From: Mahfuza Date: Sun, 20 Aug 2023 10:47:35 +0600 Subject: [PATCH 2/7] update Signed-off-by: Mahfuza --- .../current/contribute/contribute.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md index 67f3debc..e0dff56a 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md @@ -27,7 +27,7 @@ If you split your pull request into small changes, please make sure any of the c ### Fork and Clone the Repository -Fork [the WasmEdge repository](https://github.com/WasmEdge/WasmEdge) and clone the code to your local workspace +Fork [the WasmEdge repository](https://github.com/WasmEdge/WasmEdge) and clone the code to your local workspace. ### Branches and Commits @@ -50,8 +50,18 @@ LD_LIBRARY_PATH=$(pwd)/lib/api ctest When ready for review, push your branch to your fork repository on github. +Please sign your commits before sending a PR. To sign off on a commit, you just add a line at the end of your commit message with your signature like: + +```bash +Signed-off-by: Sarrah Bastawala +``` + +This can be automatically added to your commit message by passing -s or --signoff to git commit. + Then visit your fork at and click the `Compare & Pull Request` button next to your branch to create a new pull request. Description of a pull request should refer to all the issues that it addresses. Remember to put a reference to issues (such as Closes #XXX and Fixes #XXX) in the comment so that the issues can be closed when the PR is merged. After creating a pull request, please check that the CI passes with your code changes. +After creating a pull request, please ensure that the CI passes with your code and documentation changes. + Once your pull request has been opened it will be assigned to one or more reviewers. Those reviewers will do a thorough code review, looking for correctness, bugs, opportunities for improvement, documentation and comments, and coding style. Commit changes made in response to review comments to the same branch on your fork. @@ -78,3 +88,7 @@ Update the documentation if you are creating or changing features. Good document You can propose new designs for existing WasmEdge features. You can also design entirely new features, please submit a proposal via the GitHub issues. WasmEdge maintainers will review this proposal as soon as possible. This is necessary to ensure the overall architecture is consistent and to avoid duplicated work in the roadmap. + +## Code of Conduct + +We value the participation and collaboration of every member of our community. Therefore, we require all participants to adhere to our [Code of Conduct](https://github.com/WasmEdge/WasmEdge/blob/master/docs/CODE_OF_CONDUCT.md). From 0aa7cd617322a44bf7bdd3754fdb6221a2c09a03 Mon Sep 17 00:00:00 2001 From: Mahfuza Date: Sun, 20 Aug 2023 11:05:41 +0600 Subject: [PATCH 3/7] added roadmap link Signed-off-by: Mahfuza --- docs/contribute/contribute.md | 4 ++-- .../current/contribute/contribute.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/contribute/contribute.md b/docs/contribute/contribute.md index e0dff56a..ee3e6a48 100644 --- a/docs/contribute/contribute.md +++ b/docs/contribute/contribute.md @@ -53,7 +53,7 @@ When ready for review, push your branch to your fork repository on github. Please sign your commits before sending a PR. To sign off on a commit, you just add a line at the end of your commit message with your signature like: ```bash -Signed-off-by: Sarrah Bastawala +Signed-off-by: Author Name ``` This can be automatically added to your commit message by passing -s or --signoff to git commit. @@ -87,7 +87,7 @@ Update the documentation if you are creating or changing features. Good document You can propose new designs for existing WasmEdge features. You can also design entirely new features, please submit a proposal via the GitHub issues. -WasmEdge maintainers will review this proposal as soon as possible. This is necessary to ensure the overall architecture is consistent and to avoid duplicated work in the roadmap. +WasmEdge maintainers will review this proposal as soon as possible. This is necessary to ensure the overall architecture is consistent and to avoid duplicated work in the [roadmap](https://github.com/mhmohona/WasmEdge/blob/coding-style/docs/ROADMAP.md). ## Code of Conduct diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md index e0dff56a..ee3e6a48 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md @@ -53,7 +53,7 @@ When ready for review, push your branch to your fork repository on github. Please sign your commits before sending a PR. To sign off on a commit, you just add a line at the end of your commit message with your signature like: ```bash -Signed-off-by: Sarrah Bastawala +Signed-off-by: Author Name ``` This can be automatically added to your commit message by passing -s or --signoff to git commit. @@ -87,7 +87,7 @@ Update the documentation if you are creating or changing features. Good document You can propose new designs for existing WasmEdge features. You can also design entirely new features, please submit a proposal via the GitHub issues. -WasmEdge maintainers will review this proposal as soon as possible. This is necessary to ensure the overall architecture is consistent and to avoid duplicated work in the roadmap. +WasmEdge maintainers will review this proposal as soon as possible. This is necessary to ensure the overall architecture is consistent and to avoid duplicated work in the [roadmap](https://github.com/mhmohona/WasmEdge/blob/coding-style/docs/ROADMAP.md). ## Code of Conduct From 10aac517d88e82bcac81ee2f26fff02a43fbf960 Mon Sep 17 00:00:00 2001 From: Mahfuza Date: Sun, 20 Aug 2023 11:13:50 +0600 Subject: [PATCH 4/7] add about ecosystem Signed-off-by: Mahfuza --- docs/contribute/contribute.md | 15 ++++++++++++++- .../current/contribute/contribute.md | 15 ++++++++++++++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/docs/contribute/contribute.md b/docs/contribute/contribute.md index ee3e6a48..a8ba438f 100644 --- a/docs/contribute/contribute.md +++ b/docs/contribute/contribute.md @@ -25,6 +25,19 @@ Please submit a pull request broken down into small changes bit by bit. A pull r If you split your pull request into small changes, please make sure any of the changes that goes to master will not break anything. Otherwise, it can not be merged until this feature is complete. ::: +## Understanding the WasmEdge Ecosystem + +Contributing to WasmEdge is more than just code. It's about understanding where WasmEdge fits into the broader ecosystem of WebAssembly and edge computing. Here are a few key aspects of the WasmEdge ecosystem: + +- **WasmEdge Runtime**: The high-performance, extensible WebAssembly runtime for cloud native infrastructure and edge IoT devices. +- **WasmEdge Extensions**: A series of function-as-a-service extensions for the WasmEdge Runtime, such as Tensorflow Lite and Image Magick. +- **Cargo-wasi**: A lightweight WebAssembly CDN service built on the WasmEdge Runtime. +- **SSVM**: A server-side WebAssembly VM optimized for server-side applications. It powers server-side functions in Node.js, Rust, and Golang to provide high-performance execution of applications in a sandboxed environment. + +You can check out more [about the WasmEdge ecosystem](https://github.com/WasmEdge/WasmEdge/blob/master/docs/ecosystem.md) to understand how these parts work together. + +By understanding the ecosystem, you can make more impactful contributions and see how your work advances the overall goals of WasmEdge and WebAssembly in the cloud and edge computing. + ### Fork and Clone the Repository Fork [the WasmEdge repository](https://github.com/WasmEdge/WasmEdge) and clone the code to your local workspace. @@ -87,7 +100,7 @@ Update the documentation if you are creating or changing features. Good document You can propose new designs for existing WasmEdge features. You can also design entirely new features, please submit a proposal via the GitHub issues. -WasmEdge maintainers will review this proposal as soon as possible. This is necessary to ensure the overall architecture is consistent and to avoid duplicated work in the [roadmap](https://github.com/mhmohona/WasmEdge/blob/coding-style/docs/ROADMAP.md). +WasmEdge maintainers will review this proposal as soon as possible. This is necessary to ensure the overall architecture is consistent and to avoid duplicated work in the [roadmap](https://github.com/WasmEdge/WasmEdge/blob/master/docs/ROADMAP.md). ## Code of Conduct diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md index ee3e6a48..a8ba438f 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md @@ -25,6 +25,19 @@ Please submit a pull request broken down into small changes bit by bit. A pull r If you split your pull request into small changes, please make sure any of the changes that goes to master will not break anything. Otherwise, it can not be merged until this feature is complete. ::: +## Understanding the WasmEdge Ecosystem + +Contributing to WasmEdge is more than just code. It's about understanding where WasmEdge fits into the broader ecosystem of WebAssembly and edge computing. Here are a few key aspects of the WasmEdge ecosystem: + +- **WasmEdge Runtime**: The high-performance, extensible WebAssembly runtime for cloud native infrastructure and edge IoT devices. +- **WasmEdge Extensions**: A series of function-as-a-service extensions for the WasmEdge Runtime, such as Tensorflow Lite and Image Magick. +- **Cargo-wasi**: A lightweight WebAssembly CDN service built on the WasmEdge Runtime. +- **SSVM**: A server-side WebAssembly VM optimized for server-side applications. It powers server-side functions in Node.js, Rust, and Golang to provide high-performance execution of applications in a sandboxed environment. + +You can check out more [about the WasmEdge ecosystem](https://github.com/WasmEdge/WasmEdge/blob/master/docs/ecosystem.md) to understand how these parts work together. + +By understanding the ecosystem, you can make more impactful contributions and see how your work advances the overall goals of WasmEdge and WebAssembly in the cloud and edge computing. + ### Fork and Clone the Repository Fork [the WasmEdge repository](https://github.com/WasmEdge/WasmEdge) and clone the code to your local workspace. @@ -87,7 +100,7 @@ Update the documentation if you are creating or changing features. Good document You can propose new designs for existing WasmEdge features. You can also design entirely new features, please submit a proposal via the GitHub issues. -WasmEdge maintainers will review this proposal as soon as possible. This is necessary to ensure the overall architecture is consistent and to avoid duplicated work in the [roadmap](https://github.com/mhmohona/WasmEdge/blob/coding-style/docs/ROADMAP.md). +WasmEdge maintainers will review this proposal as soon as possible. This is necessary to ensure the overall architecture is consistent and to avoid duplicated work in the [roadmap](https://github.com/WasmEdge/WasmEdge/blob/master/docs/ROADMAP.md). ## Code of Conduct From 265bcafe5567dc1b8950b8f859bf88bd40739e5d Mon Sep 17 00:00:00 2001 From: Mahfuza Date: Sun, 20 Aug 2023 16:41:45 +0600 Subject: [PATCH 5/7] fix typo Signed-off-by: Mahfuza --- docs/contribute/contribute.md | 8 -------- .../current/contribute/contribute.md | 8 -------- 2 files changed, 16 deletions(-) diff --git a/docs/contribute/contribute.md b/docs/contribute/contribute.md index fe770ed3..6098562e 100644 --- a/docs/contribute/contribute.md +++ b/docs/contribute/contribute.md @@ -63,14 +63,6 @@ LD_LIBRARY_PATH=$(pwd)/lib/api ctest When ready for review, push your branch to your fork repository on github. -Please sign your commits before sending a PR. To sign off on a commit, you just add a line at the end of your commit message with your signature like: - -```bash -Signed-off-by: Author Name -``` - -This can be automatically added to your commit message by passing -s or --signoff to git commit. - Then visit your fork at and click the `Compare & Pull Request` button next to your branch to create a new pull request. Description of a pull request should refer to all the issues that it addresses. Remember to put a reference to issues (such as Closes #XXX and Fixes #XXX) in the comment so that the issues can be closed when the PR is merged. After creating a pull request, please check that the CI passes with your code changes. After creating a pull request, please ensure that the CI passes with your code and documentation changes. diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md index fe770ed3..6098562e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md @@ -63,14 +63,6 @@ LD_LIBRARY_PATH=$(pwd)/lib/api ctest When ready for review, push your branch to your fork repository on github. -Please sign your commits before sending a PR. To sign off on a commit, you just add a line at the end of your commit message with your signature like: - -```bash -Signed-off-by: Author Name -``` - -This can be automatically added to your commit message by passing -s or --signoff to git commit. - Then visit your fork at and click the `Compare & Pull Request` button next to your branch to create a new pull request. Description of a pull request should refer to all the issues that it addresses. Remember to put a reference to issues (such as Closes #XXX and Fixes #XXX) in the comment so that the issues can be closed when the PR is merged. After creating a pull request, please check that the CI passes with your code changes. After creating a pull request, please ensure that the CI passes with your code and documentation changes. From c1713ee1558408c01e153a80a8cbbabaa2ef9d5d Mon Sep 17 00:00:00 2001 From: Mahfuza Date: Sun, 10 Sep 2023 07:22:30 +0600 Subject: [PATCH 6/7] updating Ecosystem section Signed-off-by: Mahfuza --- docs/contribute/contribute.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/contribute/contribute.md b/docs/contribute/contribute.md index 6098562e..da321db6 100644 --- a/docs/contribute/contribute.md +++ b/docs/contribute/contribute.md @@ -27,16 +27,17 @@ If you split your pull request into small changes, please ensure any changes tha ## Understanding the WasmEdge Ecosystem -Contributing to WasmEdge is more than just code. It's about understanding where WasmEdge fits into the broader ecosystem of WebAssembly and edge computing. Here are a few key aspects of the WasmEdge ecosystem: +The WasmEdge Ecosystem describes the architecture and components that make up the WasmEdge project. The ecosystem can be broken down into several key components: -- **WasmEdge Runtime**: The high-performance, extensible WebAssembly runtime for cloud native infrastructure and edge IoT devices. -- **WasmEdge Extensions**: A series of function-as-a-service extensions for the WasmEdge Runtime, such as Tensorflow Lite and Image Magick. -- **Cargo-wasi**: A lightweight WebAssembly CDN service built on the WasmEdge Runtime. -- **SSVM**: A server-side WebAssembly VM optimized for server-side applications. It powers server-side functions in Node.js, Rust, and Golang to provide high-performance execution of applications in a sandboxed environment. +- **Core**: This is the central part of the WasmEdge project. The core functionality of the WasmEdge runtime resides here. + +- **Plugins**: These are extensions of WASM host functions along with their dependencies. They extend the functionality of the WasmEdge runtime. + +- **Tools**: These are runtime executables. For instance, WasmEdge-TensorFlow-Tools are released tools to execute WASM with access to TensorFlow or TensorFlow-Lite. You can check out more [about the WasmEdge ecosystem](https://github.com/WasmEdge/WasmEdge/blob/master/docs/ecosystem.md) to understand how these parts work together. -By understanding the ecosystem, you can make more impactful contributions and see how your work advances the overall goals of WasmEdge and WebAssembly in the cloud and edge computing. +By understanding the ecosystem, you can make more impactful contributions and see how your work advances the overall goals of WasmEdge. ### Fork and Clone the Repository From e157778fc599b9a35fb0f2e7a07e0af9a3f8e3f2 Mon Sep 17 00:00:00 2001 From: Mahfuza Date: Wed, 13 Sep 2023 07:28:57 +0600 Subject: [PATCH 7/7] small fix Signed-off-by: Mahfuza --- .../current/contribute/contribute.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md index 6098562e..da321db6 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/contribute/contribute.md @@ -27,16 +27,17 @@ If you split your pull request into small changes, please ensure any changes tha ## Understanding the WasmEdge Ecosystem -Contributing to WasmEdge is more than just code. It's about understanding where WasmEdge fits into the broader ecosystem of WebAssembly and edge computing. Here are a few key aspects of the WasmEdge ecosystem: +The WasmEdge Ecosystem describes the architecture and components that make up the WasmEdge project. The ecosystem can be broken down into several key components: -- **WasmEdge Runtime**: The high-performance, extensible WebAssembly runtime for cloud native infrastructure and edge IoT devices. -- **WasmEdge Extensions**: A series of function-as-a-service extensions for the WasmEdge Runtime, such as Tensorflow Lite and Image Magick. -- **Cargo-wasi**: A lightweight WebAssembly CDN service built on the WasmEdge Runtime. -- **SSVM**: A server-side WebAssembly VM optimized for server-side applications. It powers server-side functions in Node.js, Rust, and Golang to provide high-performance execution of applications in a sandboxed environment. +- **Core**: This is the central part of the WasmEdge project. The core functionality of the WasmEdge runtime resides here. + +- **Plugins**: These are extensions of WASM host functions along with their dependencies. They extend the functionality of the WasmEdge runtime. + +- **Tools**: These are runtime executables. For instance, WasmEdge-TensorFlow-Tools are released tools to execute WASM with access to TensorFlow or TensorFlow-Lite. You can check out more [about the WasmEdge ecosystem](https://github.com/WasmEdge/WasmEdge/blob/master/docs/ecosystem.md) to understand how these parts work together. -By understanding the ecosystem, you can make more impactful contributions and see how your work advances the overall goals of WasmEdge and WebAssembly in the cloud and edge computing. +By understanding the ecosystem, you can make more impactful contributions and see how your work advances the overall goals of WasmEdge. ### Fork and Clone the Repository