Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Community Page #153

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Improve Community Page #153

wants to merge 9 commits into from

Conversation

mhmohona
Copy link
Contributor

@mhmohona mhmohona commented Aug 20, 2023

Explanation

Improved the Push and Create A Pull Request section.
Added Code of Conduct section.
Added Understanding the WasmEdge Ecosystem section

Related issue

What type of PR is this

/kind documentation

Proposed Changes

Signed-off-by: Mahfuza <[email protected]>
Copy link
Collaborator

alabulei1 commented Aug 20, 2023

Hello, I am a code review bot on flows.network. Here are my reviews of code commits in this PR.


Overall, the "Improve Community Page" Pull Request brings several positive changes to the community section. It adds instructions for signing commits, a reminder to ensure CI passes, and a section about the Code of Conduct. The changes promote a positive and inclusive environment.

There are a few potential issues and errors that need to be addressed. These include a minor typo in the commit message, a mismatch between the language of the patch and the file being modified, a lack of explanation for the changes made, the need to verify the URIs used, and the need for more elaboration on the purpose of signing off commits.

The key findings from the overall summary include the positive impact of the changes on the community section, the need to address potential issues and errors, and the importance of providing more context and elaboration for certain changes.

Details

Commit 5a6add96d8f8a181cb8e107879b92e18715265a0

Key changes:

  • Added instructions for signing commits before sending a PR.
  • Added a reminder to ensure that CI passes with code and documentation changes.
  • Added a section about the Code of Conduct and included a link to it.

Potential problems:

  • No potential problems found.

Overall, these changes improve the community section by providing additional guidelines for contributors and promoting a positive and inclusive environment through the inclusion of the Code of Conduct.

Commit 759e0bde7e1df8b454c1cdf73d7746a97cedb09a

Key changes in the patch:

  1. Added information about signing off commits before sending a pull request.
  2. Added a reminder to ensure that the CI passes for code and documentation changes.
  3. Added a section about the Code of Conduct and provided a link to it.

Potential problems:

  1. There is a minor typo in the first line of the commit message. Instead of "update", it would be helpful to have a more descriptive message about the specific changes made in the patch.
  2. The patch makes changes to a file in a specific language, "zh" (presumably Chinese), but the patch itself is in English. This might indicate a mismatch between the language of the file and the language used in the patch.
  3. The patch adds new content without mentioning the reason or motivation behind the changes. It would be beneficial to include a brief explanation of why these changes are being made.
  4. The URIs for the repository and the Code of Conduct link should be checked to ensure they are correct and up to date.
  5. The section about signing off commits could have further elaboration on why it is necessary and what purpose it serves.

Overall, the changes in the patch appear to improve the community page by adding important information and reminders. However, some minor issues and potential problems need to be addressed before merging the pull request.

Commit 0aa7cd617322a44bf7bdd3754fdb6221a2c09a03

Key Changes:

  • Added a hyperlink to the roadmap in the contribute.md file.

Potential Problems:

  • The email address in the Signed-off-by line is still using the author's personal email address. It should be updated to use a more generic email address.
  • The hyperlink to the roadmap is hardcoded to a specific branch and location in the repository. It may need to be updated if the repository structure changes or if the roadmap file is moved.

Overall, the changes seem reasonable and do not introduce any major issues.

Commit 10aac517d88e82bcac81ee2f26fff02a43fbf960

Key Changes:

  • Added a new section "Understanding the WasmEdge Ecosystem" to the contribute.md file.
  • Provided information about the WasmEdge ecosystem and its key aspects.

Potential Problems:

  • No potential problems found.

Overall, the patch adds a new section to the contribute.md file, providing information about the WasmEdge ecosystem. The changes appear to be well-implemented and there are no potential problems identified.

Commit 265bcafe5567dc1b8950b8f859bf88bd40739e5d

Key changes:

  • The patch removes a section in both the English and Chinese versions of the contribute.md file. The removed section instructs the contributor to sign off on their commits before sending a pull request.

Potential problems:

  • The patch only removes content, so there is no risk of introducing new issues or bugs.
  • However, it's worth noting that removing the instructions for signing off on commits may lead to confusion for future contributors who are not familiar with the process. It might be beneficial to add a comment explaining why this section was removed or provide alternative instructions for signing off on commits if applicable.

Commit c1713ee1558408c01e153a80a8cbbabaa2ef9d5d

Key changes:

  • The description of the WasmEdge ecosystem has been updated with more specific details about its components.
  • The link to the WasmEdge ecosystem documentation has been updated.

Potential problems:

  • The patch seems to be focused on updating the description of the WasmEdge ecosystem, which appears to be a valid improvement.
  • However, without context about the previous version of the document and the specific goals of the improvement, it is difficult to determine if the changes are appropriate and effective.

Additional suggestions:

  • It would be helpful to provide more information about the motivation behind this patch and the specific goals it aims to achieve.
  • Consider adding more details about the changes made to the ecosystem description to provide a clearer understanding of the improvements.

Commit e157778fc599b9a35fb0f2e7a07e0af9a3f8e3f2

Key changes in this patch include:

  • Reorganization of the content to provide a clearer description of the WasmEdge ecosystem, including its core, plugins, and tools.
  • Improved formatting and wording in some sections.

Potential problems:

  • There don't appear to be any major problems with this patch. The changes seem to be relatively straightforward and enhance the clarity of the content. However, it would be helpful to have more context on the overall goals of the "Improve Community Page" Pull Request to better evaluate the significance of these changes.

@alabulei1
Copy link
Collaborator

Hi @mhmohona

Please check out my comments. Thanks.

docs/contribute/contribute.md Outdated Show resolved Hide resolved
docs/contribute/contribute.md Outdated Show resolved Hide resolved
docs/contribute/contribute.md Outdated Show resolved Hide resolved
@alabulei1
Copy link
Collaborator

Hi @mhmohona

Did you have any updates on this project?

Signed-off-by: Mahfuza <[email protected]>

- **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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@q82419 Could you please confirm if the message here is out of date? I remember that tensorflow also is a plugin. Thanks.

@alabulei1
Copy link
Collaborator

Hi @mhmohona

You didn't reply to my last comment. Please take a look. Thanks.

@mhmohona
Copy link
Contributor Author

Hey @alabulei1, wasnt the question asked to @q82419?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants