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
+9-14Lines changed: 9 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,6 @@ sidebar_position: 8
4
4
5
5
# Contributing Guide
6
6
7
-
8
7
*[New Contributor Guide](#contributing-guide)
9
8
*[Ways to Contribute](#ways-to-contribute)
10
9
*[Find an Issue](#find-an-issue)
@@ -43,11 +42,10 @@ We welcome many different types of contributions including:
43
42
44
43
Not everything happens through a GitHub pull request. Please come to our
45
44
[meetings](https://docs.google.com/document/d/1iFlVl7R97Lze4RDykzElJGDjjWYDlkI8Rhf8g4dQ5Rk/edit?usp=sharing) or [contact us](https://groups.google.com/g/wasmedge) and let's discuss how we can work
46
-
together.
45
+
together.
47
46
48
47
### Come to Meetings
49
48
50
-
51
49
Absolutely everyone is welcome to come to any of our meetings. You never need an
52
50
invite to join us. In fact, we want you to join us, even if you don’t have
53
51
anything you feel like you want to contribute. Just being there is enough!
@@ -66,7 +64,7 @@ suitable for someone who isn't a core maintainer and is good to move onto after
66
64
your first pull request.
67
65
68
66
Sometimes there won’t be any issues with these labels. That’s ok! There is
69
-
likely still something for you to work on. If you want to contribute but
67
+
likely still something for you to work on. If you want to contribute but
70
68
don’t know where to start or can't find a suitable issue, you can leave a comment under this issue like "I'd like to work on this. Can you tell XYZ (list the stuff you want to communicate)" or send your questions to our discord server or slack channel.
71
69
72
70
Once you see an issue that you'd like to work on, please post a comment saying
@@ -85,12 +83,11 @@ Before opening any issue, please look up the existing [issues](https://github.co
85
83
86
84
When reporting issues, always include:
87
85
88
-
- Version of your system
89
-
- Configuration files of WasmEdge
86
+
* Version of your system
87
+
* Configuration files of WasmEdge
90
88
91
89
Because the issues are open to the public, when submitting the log and configuration files, be sure to remove any sensitive information, e.g. user name, password, IP address, and company name. You can replace those parts with "REDACTED" or other strings like "\*\*\*\*". Be sure to include the steps to reproduce the problem if applicable. It can help us understand and fix your issue faster.
92
90
93
-
94
91
## Pull Request Lifecycle
95
92
96
93
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.
@@ -99,13 +96,13 @@ Please submit a pull request broken down into small changes bit by bit. A pull r
99
96
100
97
Generally, 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. If your PR is not ready to review, please mark your PR as a draft.
101
98
102
-
The reviewers will give you some feedback in three work days.
99
+
The reviewers will give you some feedback in three work days.
103
100
104
-
After the first review is done, the PR contributor is expected to review and make some changes based on the review in 5 workdays.
101
+
After the first review is done, the PR contributor is expected to review and make some changes based on the review in 5 workdays.
105
102
106
103
If you have finished the adjustments, mark the problem as solved, then the reviewers will review your PR again in 2 workdays.
107
104
108
-
If the PR contributor doesn't respond to the PR in 30 days, the maintainer will close the PR. The original PR contributor is welcome to open it again.
105
+
If the PR contributor doesn't respond to the PR in 30 days, the maintainer will close the PR. The original PR contributor is welcome to open it again.
109
106
110
107
If the PR contributor doesn't want to maintain the PR due to some reason, please enable maintainers to edit this PR if you still want this PR to be merged.
111
108
@@ -124,6 +121,7 @@ To build WasmEdge from the source, please refer to: [Build WasmEdge from source]
124
121
## Sign Your Commits
125
122
126
123
### DCO
124
+
127
125
Licensing is important to open source projects. It provides some assurances that
128
126
the software will continue to be available based under the terms that the
129
127
author(s) desired. We require that contributors sign off on commits submitted to
@@ -143,11 +141,10 @@ Git has a `-s` command line option to do this automatically:
143
141
git commit -s -m 'This is my commit message'
144
142
145
143
If you forgot to do this and have not yet pushed your changes to the remote
146
-
repository, you can amend your commit with the sign-off by running
144
+
repository, you can amend your commit with the sign-off by running
147
145
148
146
git commit --amend -s
149
147
150
-
151
148
## Pull Request Checklist
152
149
153
150
When you submit your pull request, or you push new commits to it, our automated
@@ -159,10 +156,8 @@ before you submit your code:
159
156
* DCO: Did you sign off your commit
160
157
* Code of conduct: Did you follow the CNCF code of conduct
161
158
162
-
163
159
## Reporting issues
164
160
165
-
166
161
## Documenting
167
162
168
163
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.
Copy file name to clipboardExpand all lines: docs/contribute/source/plugin/wasi_logging.md
+6Lines changed: 6 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -6,6 +6,12 @@ sidebar_position: 1
6
6
7
7
WASI-Logging allows WebAssembly applications to log messages in a standardized way. This becomes particularly helpful when debugging applications or understanding the flow of execution within them. The WASI-Logging plug-in is designed to be straightforward to use, enabling developers to focus more on their application logic and less on logging mechanics.
8
8
9
+
<!-- prettier-ignore -->
10
+
:::note
11
+
In WasmEdge `0.14.1` version, this plug-in is bundled into the WasmEdge library and not generate the plug-in shared library.
12
+
The plug-in building architecture will be refactored in the future. Therefore we reserve this page for documentation before `0.14.0` versions.
13
+
:::
14
+
9
15
## Prerequisites
10
16
11
17
The prerequisite of the Wasi-Logging plug-in is the same as the WasmEdge building environment on the [Linux](../os/linux.md) and [MacOS](../os/macos.md) platforms.
0 commit comments