Skip to content

Commit b69f8f5

Browse files
authored
Fix typo (#144)
* correct sentence structure and typo Signed-off-by: Mahfuza <mhmohona@gmail.com> * fix typo Signed-off-by: Mahfuza <mhmohona@gmail.com> * fix plug-in typo Signed-off-by: Mahfuza <mhmohona@gmail.com> * fix typo Signed-off-by: Mahfuza <mhmohona@gmail.com> * fixed typo Signed-off-by: Mahfuza <mhmohona@gmail.com> * fixed typo Signed-off-by: Mahfuza <mhmohona@gmail.com> --------- Signed-off-by: Mahfuza <mhmohona@gmail.com>
1 parent 30e0037 commit b69f8f5

File tree

199 files changed

+1340
-1348
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

199 files changed

+1340
-1348
lines changed

docs/contribute/contribute.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ The WasmEdge is developed on Ubuntu 20.04 to take advantage of advanced LLVM fea
1010

1111
Our development environment requires `libLLVM-12` and `>=GLIBCXX_3.4.26`.
1212

13-
If you are using an operating system older than Ubuntu 20.04, please use our [special docker image] to build WasmEdge. If you are looking for the pre-built binaries for the older operating system, we also provide several pre-built binaries based on `manylinux2014` distribution.
13+
If you use an operating system older than Ubuntu 20.04, please use our [special docker image] to build WasmEdge. If you are looking for the pre-built binaries for the older operating system, we also provide several pre-built binaries based on the `manylinux2014` distribution.
1414

1515
To build WasmEdge from the source, please refer to: [Build WasmEdge from source](/category/build-wasmedge-from-source).
1616

1717
## Contribution Workflow
1818

19-
Pull requests are always welcome, even if they only contain small fixes like typos or a few lines of code. If there will be a significant effort, please document it as an issue and get a discussion going before starting to work on it.
19+
Pull requests are always welcome, even if they only contain minor fixes like typos or a few lines of code. If there will be a significant effort, please document it as an issue and get a discussion going before starting to work on it.
2020

21-
Please submit a pull request broken down into small changes bit by bit. A pull request consisting of a lot features and code changes may be hard to review. It is recommended to submit pull requests in an incremental fashion.
21+
Please submit a pull request broken down into small changes bit by bit. A pull request consisting of many features and code changes may take a lot of work to review. It is recommended to submit pull requests incrementally.
2222

2323
<!-- prettier-ignore -->
2424
:::note
25-
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.
25+
If you split your pull request into small changes, please ensure any changes that go to the main branch will not break anything. Otherwise, it can only be merged once this feature is complete.
2626
:::
2727

2828
### Fork and Clone the Repository
@@ -31,11 +31,11 @@ Fork [the WasmEdge repository](https://github.com/WasmEdge/WasmEdge) and clone t
3131

3232
### Branches and Commits
3333

34-
Changes should be made on your own fork in a new branch. Pull requests should be rebased on the top of master.
34+
Changes should be made on your own fork in a new branch. Pull requests should be rebased on the top of the main branch.
3535

36-
The WasmEdge project adopts [DCO](https://www.secondstate.io/articles/dco/) to manage all contributions. Please make sure you add your `sign-off-statement` through the `-s` or `--signoff` flag or the GitHub Web UI before committing the pull request message.
36+
The WasmEdge project adopts [DCO](https://www.secondstate.io/articles/dco/) to manage all contributions. Please ensure you add your `sign-off-statement` through the `-s` or `--signoff` flag or the GitHub Web UI before committing the pull request message.
3737

38-
### Develop, Build and Test
38+
### Develop, Build, and Test
3939

4040
Write code on the new branch in your fork, and [build from source code](/category/build-wasmedge-from-source) with the option `-DWASMEDGE_BUILD_TESTS=ON`.
4141

@@ -50,17 +50,17 @@ LD_LIBRARY_PATH=$(pwd)/lib/api ctest
5050

5151
When ready for review, push your branch to your fork repository on github.
5252

53-
Then visit your fork at <https://github.com/$user/WasmEdge> 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.
53+
Then visit your fork at <https://github.com/$user/WasmEdge> and click the `Compare & Pull Request` button next to your branch to create a new pull request. The pull request description should refer to all the issues it addresses. Remember to reference 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.
5454

55-
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.
55+
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.
5656

5757
Commit changes made in response to review comments to the same branch on your fork.
5858

5959
## Reporting issues
6060

61-
It is a great way to contribute to WasmEdge by reporting an issue. Well-written and complete bug reports are always welcome! Please open an issue on Github.
61+
It is a great way to contribute to WasmEdge by reporting an issue. Well-written and complete bug reports are always welcome! Please open an issue on GitHub.
6262

63-
Before opening any issue, please look up the existing [issues](https://github.com/WasmEdge/WasmEdge/issues) to avoid submitting a duplication. If you find a match, you can "subscribe" to it to get notified on updates. If you have additional helpful information about the issue, please leave a comment.
63+
Before opening any issue, please look up the existing [issues](https://github.com/WasmEdge/WasmEdge/issues) to avoid submitting a duplication. If you find a match, you can "subscribe" to it to get notified of updates. If you have additional helpful information about the issue, please leave a comment.
6464

6565
When reporting issues, always include:
6666

@@ -71,10 +71,10 @@ Because the issues are open to the public, when submitting the log and configura
7171

7272
## Documenting
7373

74-
Update the documentation if you are creating or changing features. Good documentation is as important as the code itself. Documents are written with Markdown. See [Writing on GitHub](https://help.github.com/categories/writing-on-github/) for more details.
74+
Update the documentation if you are creating or changing features. Good documentation is as necessary as the code itself. Documents are written with Markdown. See [Writing on GitHub](https://help.github.com/categories/writing-on-github/) for more details.
7575

7676
## Design new features
7777

78-
You can propose new designs for existing WasmEdge features. You can also design entirely new features, please submit a proposal via the GitHub issues.
78+
You can propose new designs for existing WasmEdge features. You can also design new features; please submit a proposal via the GitHub issues.
7979

80-
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.
80+
WasmEdge maintainers will review this proposal as soon as possible to ensure the overall architecture is consistent and to avoid duplicated work in the roadmap.

docs/contribute/installer.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ WasmEdge installer is designed for installing the Core Tools (`wasmedge`, `wasme
1010

1111
## Dependencies
1212

13-
In the first version of the installer, WasmEdge provides a pure shell script implementation. However, it's not easy to maintain and is not suitable when we want to include the extensions and plugins matrix.
13+
In the first version of the installer, WasmEdge provides a pure shell script implementation. However, it's not easy to maintain and unsuitable when we want to include the extensions and plugins matrix.
1414

15-
To reduce the cost of maintenance and improve the development performance, we decided to move forward to a brand new installer that is written in Python and is compatible with both Python 2 and 3.
15+
To reduce the maintenance cost and improve the development performance, we decided to move forward to a brand new installer written in python and compatible with both Python 2 and 3.
1616

1717
To be compatible with the old one, we use the same entry point, `install.sh`.
1818

@@ -31,18 +31,18 @@ The installer entry point.
3131
#### Process
3232

3333
1. Check if the `git` is installed; otherwise, exit with an error `Please install git`.
34-
2. If `PYTHON_EXECUTABLE` is given, then try to use `$PYTHON_EXECUTABLE` to execute the `install.py`. Otherwise, go to step 3.
35-
3. If `PYTHON_EXECUTABLE` is not set, `which` command is needed to determine the python-X executable. If it is not found installer exits else it moves on to the next step.
34+
2. If `PYTHON_EXECUTABLE` is given, try to use `$PYTHON_EXECUTABLE` to execute the `install.py`. Otherwise, go to step 3.
35+
3. If `PYTHON_EXECUTABLE` is not set, `which` command is needed to determine the python-X executable. If it is not found installer exits else, it moves on to the next step.
3636
4. Check if the `python3` is installed. If so, go to step 6. Otherwise, go to step 5.
3737
5. Check if the `python2` is installed. If so, go to step 6. Otherwise, go to step 6.
3838
6. Check if the `python` is installed. If so, go to step 7. Otherwise, exit with an error `Please install python or provide python path via $PYTHON_EXECUTABLE`.
3939
7. Print the detected python version `Using Python: $PYTHON_EXECUTABLE`.
40-
8. Download `install.py` with `curl` or `wget`. If the URL of `install.py` is unreachable due to a network issue, exit with an error `$INSTALL_PY_URL not reachable`. If the `curl` and `wget` are not available, exit with an error `curl or wget could not be found`.
40+
8. Download `install.py` with `curl` or `wget`. If the URL of `install.py` is unreachable due to a network issue, exit with an error `$INSTALL_PY_URL not reachable`. If the `curl` and `wget` are unavailable, exit with an error `curl or wget could not be found`.
4141
9. Execute the `install.py` with all received arguments.
4242

4343
### `install.py`
4444

45-
The real installer handles all stuff. It supports python2.7 (not tested on earlier versions) as well as the latest python versions python3.x.
45+
The actual installer handles all stuff. It supports python2.7 (not tested on earlier versions) and the latest python versions python3.x.
4646

4747
## Options
4848

@@ -64,14 +64,14 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
6464
- Full Option: `--version VERSION`
6565
- Description: Install the given VERSION of WasmEdge
6666
- Available Value: VERSION `{{ wasmedge_version }}` or other valid release versions.
67-
- Note - In the case of supplied an invalid or nonexistent version, the installer exists with an error.
67+
- Note - If supplied an invalid or nonexistent version, the installer exists with an error.
6868

6969
### Installation path
7070

7171
- Short Option: `-p PATH`
7272
- Full Option: `--path PATH`
7373
- Description: Install WasmEdge into the given PATH. The default Path is `$HOME/.wasmedge`.
74-
- Note - In any path other than the ones starting with `/usr` are treated as non system paths in the internals of the installer. The consequences are different directory structures for both.
74+
- Note - Any paths other than the ones starting with `/usr` are treated as non-system paths in the internals of the installer. The consequences are different directory structures for both.
7575
- Note - If the path not exists, the folder will be created.
7676

7777
### Uninstallation
@@ -121,11 +121,11 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
121121

122122
### Plugins
123123

124-
- Note - Currently `--plugins` is an experimental option.
124+
- Note - Currently, `--plugins` is an experimental option.
125125

126126
- Full Option: `--plugins wasi_crypto:0.12.0`
127127

128-
- Note - The format for this argument is `<plugin_name>:<version_number>`. `<version_number>` is not compulsory. For example `--plugins wasi_crypto` is a valid option.
128+
- Note - The format for this argument is `<plugin_name>:<version_number>`. `<version_number>` is not compulsory. For example, `--plugins wasi_crypto` is a valid option.
129129
- Note - `<plugin_name>` is cases sensitive. Allowed values are stated [here](plugin/intro.md) in the `Rust Crate` column. The logic is that the release name should be the same.
130130
- Note - It's the same as the WasmEdge version if not specified.
131131

@@ -134,7 +134,7 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
134134
- Full Option: `--dist ubuntu20.04` or `--dist manylinux2014`
135135
- Note - the `ubuntu20.04` and `manylinux2014` values are case insensitive and only these two are currently supported.
136136
- Note - Specifying `--dist` value for `Darwin` has no effect.
137-
- Note - For `Linux` platform if the distribution matches exactly as `Ubuntu 20.04` which is checked using `lsb_release` and python's `platform.dist()` functionality then it is set to `ubuntu20.04` if not specified, else it is used without questioning. However different release packages for WasmEdge are available only after `0.11.1` release below which there is no effect of specifying this option.
137+
- Note - For `Linux` platform if the distribution matches exactly as `Ubuntu 20.04`, which is checked using `lsb_release` and python's ` platform.dist()` functionality is then set to `ubuntu20.04` if not specified, or it is used without questioning. However different release packages for WasmEdge are available only after `0.11.1` release, below which there is no effect of specifying this option.
138138

139139
### Platform and OS
140140

@@ -145,18 +145,18 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
145145
### Machine and Arch
146146

147147
- Full Option: `--machine MACHINE` or `--arch ARCH`
148-
- Description: Install the given `MACHINE` or `ARCH` version of WasmEdge.
148+
- Description: Install the `MACHINE` or `ARCH` version of WasmEdge.
149149
- Available Value: "x86_64", "aarch64".
150150

151151
## Behavior
152152

153-
- If there exists an installation at `$HOME/.wasmedge` which is to be noted as the default installation path, it is removed with or without uninstaller's invocation.
154-
- WasmEdge installation appends all the files it installs to a file which is located in the installer directory named `env` with it's path as `$INSTALLATION_PATH/env`
153+
- If an installation exists at `$HOME/.wasmedge`, to be noted as the default installation path, it is removed with or without the uninstaller's invocation.
154+
- WasmEdge installation appends all the files it installs to a file which is located in the installer directory named `env` with its path as `$INSTALLATION_PATH/env`.
155155

156156
### Shell and it's configuration
157157

158158
- Source string in shell configuration is given as `. $INSTALLATION_PATH/env` so that it exports the necessary environment variables for WasmEdge.
159159
- Shell configuration file is appended with source string if it cannot find the source string in that file.
160-
- Currently it detects only `Bash` and `zsh` shells.
161-
- If the above shells are found, then their respective configuration files `$HOME/.bashrc` and `$HOME/.zshrc` are updated along with `$HOME/.zprofile` and `$HOME/.bash_profile` in case of Linux.
162-
- In case of `Darwin`, only `$HOME/.zprofile` is updated with the source string.
160+
- Currently, it detects only `Bash` and `zsh` shells.
161+
- If the above shells are found, then their respective configuration files `$HOME/.bashrc` and `$HOME/.zshrc` are updated along with `$HOME/.zprofile` and `$HOME/.bash_profile` in the case of Linux.
162+
- In the case of `Darwin`, only `$HOME/.zprofile` is updated with the source string.

docs/contribute/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ displayed_sidebar: contributeSidebar
55

66
# Contribute and Extend WasmEdge
77

8-
Contribution is always welcome! The WebAssembly ecosystem is still in its early days. Hosted by CNCF, WasmEdge aims to become an open source “reference implementation” of WebAssembly and its edge-related extensions. WasmEdge is developed in the open, and is constantly being improved by our users, contributors, and maintainers. It is because of you that we can bring great software to the community.We're looking forward to working together with you!
8+
Contribution is always welcome! The WebAssembly ecosystem is still in its early days. Hosted by CNCF, WasmEdge aims to become an open source “reference implementation” of WebAssembly and its edge-related extensions. WasmEdge is developed in the open, and is constantly being improved by our users, contributors, and maintainers. It is because of you that we can bring great software to the community.We are looking forward to working together with you!
99

1010
To help new contributors understand WasmEdge development workflow, this guide will include
1111

@@ -27,12 +27,12 @@ If you're looking for something to contribute, we have issues
2727

2828
- labeled with [`help wanted`](https://github.com/WasmEdge/WasmEdge/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), for which are we need suggestions and opinions from the community.
2929

30-
- [Roadmap](https://github.com/WasmEdge/WasmEdge/blob/master/docs/ROADMAP.md) for every year, which elaborates the new features in the coming days. You're also welcome to pick one.
30+
- [Roadmap](https://github.com/WasmEdge/WasmEdge/blob/master/docs/ROADMAP.md) for every year, which elaborates the new features in the coming days. You are also welcome to pick one.
3131

3232
If you find something is missing, don't hesitate to create an issue and let us know. Again, WasmEdge is open in development.
3333

3434
## Mentoring
3535

36-
WasmEdge maintainers can provide mentoring for WasmEdge, WebAssembly, C++, Rust, compiler etc. If you're interest in fixing one open issue, just let us know by commenting under the issue. WasmEdge maintainers will reply to your question in time.
36+
WasmEdge maintainers can provide mentoring for WasmEdge, WebAssembly, C++, Rust, compiler, etc. If you are interested in fixing one open issue, just let us know by commenting under the issue. WasmEdge maintainers will reply to your question in time.
3737

3838
Besides the regular GitHub issues, the WasmEdge project will participate in some open source mentoring projects like [Google Summer of Code (GSoC)](https://summerofcode.withgoogle.com/), [Google Season of Docs (GSoD)](https://developers.google.com/season-of-docs), [LFX Mentorship](https://mentorship.lfx.linuxfoundation.org/#projects_all), and [Open Source Promotion Plan (OSPP)](https://summer-ospp.ac.cn/). Join our [Discord server](https://discord.gg/U4B5sFTkFc) or follow [@realwasmedge](https://twitter.com/realwasmedge) on Twitter to get alerts on the application details.

0 commit comments

Comments
 (0)