Closed mhmohona closed 7 months ago
Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR.
Overall Summary:
The majority of the changes in the GitHub Pull Request are straightforward additions and improvements to the plugin documentation, without introducing any potential problems or errors. However, there are a few noteworthy findings:
sudo
command, which may not be valid for all users.Apart from these findings, the changes provide valuable guidance on best practices for developing, testing, securing, and publishing WasmEdge plugins. The documentation improvements enhance clarity and readability overall.
Key changes:
best_practice.md
in the docs/contribute/plugin/
directory.best_practice.md
document, describing best practices for developing a WasmEdge plugin.best_practice.md
document in the i18n/zh/docusaurus-plugin-content-docs/current/contribute/plugin/
directory.Potential problems:
Key changes:
Potential problems:
Key changes in the patch:
Potential problems:
Key changes in the patch:
wasmedge-image
plugin.Potential problems:
cmake
and make
.wasmedge-image
plugin assume a Unix-like environment and the use of the sudo
command. These assumptions may not be valid for all users, leading to potential issues or confusion.ctest
command to run tests, but it does not clarify how to interpret the test results or handle any failures encountered.Overall, the patch provides valuable information on testing a WasmEdge plugin but could benefit from additional context and clarification to accommodate a wider range of users.
Key changes in the patch:
test_plugin.md
that provides guidance on writing tests for WasmEdge plugins.best_practice.md
document with the new section on testing plugins and added a link to the test_plugin.md
document.Potential problems:
Key changes in the patch:
g++
compiler.Potential problems:
cpp
, not ccp
.g++
compiler for creating a shared library, without considering other platforms or build systems.Overall, the patch provides a basic starting point for creating a plugin but lacks important details and guidance on key aspects such as purpose, registration, and testing.
Key changes:
best_practice.md
file.Potential problems:
Key changes:
Potential problems:
Overall, the changes provide valuable information on best practices for developing and publishing WasmEdge plugins, including security considerations. The addition of the new sections improves the documentation for plugin developers.
Key changes:
Potential problems:
Key changes:
Potential problems:
Key changes in the patch:
wasmedge-image
plugin.Potential problems:
Key changes:
Potential problems:
Key Changes:
Potential Problems:
Key changes in the patch:
Potential problems:
Overall, the changes seem minor and there are no major issues.
Key changes in the patch:
Potential problems:
ccp
instead of cpp
. This should be fixed.cpp
instead of c
. This should be fixed.Generally, you don't provide details in this guide.
Hi @mhmohona
Could you please check out the comments here?
Hi @mhmohona ,
As we discussed many times before, the guide you're writing now is too general to provide practical details for developers.
Explanation
Added best practice for plugins.
Related issue
https://github.com/WasmEdge/docs/issues/85
What type of PR is this
/kind documentation
Proposed Changes