You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contribute/contribute.md
+14-14Lines changed: 14 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -10,19 +10,19 @@ The WasmEdge is developed on Ubuntu 20.04 to take advantage of advanced LLVM fea
10
10
11
11
Our development environment requires `libLLVM-12` and `>=GLIBCXX_3.4.26`.
12
12
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.
14
14
15
15
To build WasmEdge from the source, please refer to: [Build WasmEdge from source](/category/build-wasmedge-from-source).
16
16
17
17
## Contribution Workflow
18
18
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.
20
20
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.
22
22
23
23
<!-- prettier-ignore -->
24
24
:::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.
26
26
:::
27
27
28
28
### Fork and Clone the Repository
@@ -31,11 +31,11 @@ Fork [the WasmEdge repository](https://github.com/WasmEdge/WasmEdge) and clone t
31
31
32
32
### Branches and Commits
33
33
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.
35
35
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.
37
37
38
-
### Develop, Build and Test
38
+
### Develop, Build, and Test
39
39
40
40
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`.
When ready for review, push your branch to your fork repository on github.
52
52
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.
54
54
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.
56
56
57
57
Commit changes made in response to review comments to the same branch on your fork.
58
58
59
59
## Reporting issues
60
60
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.
62
62
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.
64
64
65
65
When reporting issues, always include:
66
66
@@ -71,10 +71,10 @@ Because the issues are open to the public, when submitting the log and configura
71
71
72
72
## Documenting
73
73
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.
75
75
76
76
## Design new features
77
77
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.
79
79
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.
Copy file name to clipboardExpand all lines: docs/contribute/installer.md
+17-17Lines changed: 17 additions & 17 deletions
Original file line number
Diff line number
Diff line change
@@ -10,9 +10,9 @@ WasmEdge installer is designed for installing the Core Tools (`wasmedge`, `wasme
10
10
11
11
## Dependencies
12
12
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.
14
14
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.
16
16
17
17
To be compatible with the old one, we use the same entry point, `install.sh`.
18
18
@@ -31,18 +31,18 @@ The installer entry point.
31
31
#### Process
32
32
33
33
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.
36
36
4. Check if the `python3` is installed. If so, go to step 6. Otherwise, go to step 5.
37
37
5. Check if the `python2` is installed. If so, go to step 6. Otherwise, go to step 6.
38
38
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`.
39
39
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`.
41
41
9. Execute the `install.py` with all received arguments.
42
42
43
43
### `install.py`
44
44
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.
46
46
47
47
## Options
48
48
@@ -64,14 +64,14 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
64
64
- Full Option: `--version VERSION`
65
65
- Description: Install the given VERSION of WasmEdge
66
66
- 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.
68
68
69
69
### Installation path
70
70
71
71
- Short Option: `-p PATH`
72
72
- Full Option: `--path PATH`
73
73
- 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 nonsystem 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.
75
75
- Note - If the path not exists, the folder will be created.
76
76
77
77
### Uninstallation
@@ -121,11 +121,11 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
121
121
122
122
### Plugins
123
123
124
-
- Note - Currently `--plugins` is an experimental option.
124
+
- Note - Currently,`--plugins` is an experimental option.
125
125
126
126
- Full Option: `--plugins wasi_crypto:0.12.0`
127
127
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.
129
129
- 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.
130
130
- Note - It's the same as the WasmEdge version if not specified.
131
131
@@ -134,7 +134,7 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
134
134
- Full Option: `--dist ubuntu20.04` or `--dist manylinux2014`
135
135
- Note - the `ubuntu20.04` and `manylinux2014` values are case insensitive and only these two are currently supported.
136
136
- 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.
138
138
139
139
### Platform and OS
140
140
@@ -145,18 +145,18 @@ The real installer handles all stuff. It supports python2.7 (not tested on earli
145
145
### Machine and Arch
146
146
147
147
- 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.
149
149
- Available Value: "x86_64", "aarch64".
150
150
151
151
## Behavior
152
152
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`.
155
155
156
156
### Shell and it's configuration
157
157
158
158
- Source string in shell configuration is given as `. $INSTALLATION_PATH/env` so that it exports the necessary environment variables for WasmEdge.
159
159
- 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.
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!
9
9
10
10
To help new contributors understand WasmEdge development workflow, this guide will include
11
11
@@ -27,12 +27,12 @@ If you're looking for something to contribute, we have issues
27
27
28
28
- 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.
29
29
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.
31
31
32
32
If you find something is missing, don't hesitate to create an issue and let us know. Again, WasmEdge is open in development.
33
33
34
34
## Mentoring
35
35
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.
37
37
38
38
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