Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit35ba0c7

Browse files
committed
Initial commit
0 parents  commit35ba0c7

File tree

5 files changed

+200
-0
lines changed

5 files changed

+200
-0
lines changed

‎.github/workflows/main.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name:CI
2+
on:
3+
push:
4+
branches:[main]
5+
pull_request:
6+
branches:[main]
7+
8+
jobs:
9+
abi-up-to-date:
10+
name:Check ABI files are up-to-date
11+
runs-on:ubuntu-latest
12+
steps:
13+
-uses:actions/checkout@v2
14+
-uses:WebAssembly/wit-abi-up-to-date@v2
15+
with:
16+
wit-abi-tag:wit-abi-0.1.0

‎README.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
#[Example WASI proposal]
2+
3+
This template can be used to start a new proposal, which can then be proposed in the WASI Subgroup meetings.
4+
5+
The sections below are recommended. However, every proposal is different, and the community can help you flesh out the proposal, so don't block on having something filled in for each one of them.
6+
7+
Thank you to the W3C Privacy CG for the[inspiration](https://github.com/privacycg/template)!
8+
9+
#[Title]
10+
11+
A proposed[WebAssembly System Interface](https://github.com/WebAssembly/WASI) API.
12+
13+
###Current Phase
14+
15+
[Fill in the current phase, e.g. Phase 1]
16+
17+
###Champions
18+
19+
-[Champion 1]
20+
-[Champion 2]
21+
-[etc.]
22+
23+
###Phase 4 Advancement Criteria
24+
25+
TODO before entering Phase 2.
26+
27+
##Table of Contents[if the explainer is longer than one printed page]
28+
29+
-[Introduction](#introduction)
30+
-[Goals[or Motivating Use Cases, or Scenarios]](#goals-or-motivating-use-cases-or-scenarios)
31+
-[Non-goals](#non-goals)
32+
-[API walk-through](#api-walk-through)
33+
-[Use case 1](#use-case-1)
34+
-[Use case 2](#use-case-2)
35+
-[Detailed design discussion](#detailed-design-discussion)
36+
-[[Tricky design choice 1]](#tricky-design-choice-1)
37+
-[[Tricky design choice 2]](#tricky-design-choice-2)
38+
-[Considered alternatives](#considered-alternatives)
39+
-[[Alternative 1]](#alternative-1)
40+
-[[Alternative 2]](#alternative-2)
41+
-[Stakeholder Interest & Feedback](#stakeholder-interest--feedback)
42+
-[References & acknowledgements](#references--acknowledgements)
43+
44+
###Introduction
45+
46+
[The "executive summary" or "abstract". Explain in a few sentences what the goals of the project are, and a brief overview of how the solution works. This should be no more than 1-2 paragraphs.]
47+
48+
###Goals[or Motivating Use Cases, or Scenarios]
49+
50+
[What is the end-user need which this project aims to address?]
51+
52+
###Non-goals
53+
54+
[If there are "adjacent" goals which may appear to be in scope but aren't, enumerate them here. This section may be fleshed out as your design progresses and you encounter necessary technical and other trade-offs.]
55+
56+
###API walk-through
57+
58+
[Walk through of how someone would use this API.]
59+
60+
####[Use case 1]
61+
62+
[Provide example code snippets and diagrams explaining how the API would be used to solve the given problem]
63+
64+
####[Use case 2]
65+
66+
[etc.]
67+
68+
###Detailed design discussion
69+
70+
[This section should mostly refer to the .wit.md file that specifies the API. This section is for any discussion of the choices made in the API which don't make sense to document in the spec file itself.]
71+
72+
####[Tricky design choice#1]
73+
74+
[Talk through the tradeoffs in coming to the specific design point you want to make.]
75+
76+
```
77+
// Illustrated with example code.
78+
```
79+
80+
[This may be an open question, in which case you should link to any active discussion threads.]
81+
82+
####[Tricky design choice 2]
83+
84+
[etc.]
85+
86+
###Considered alternatives
87+
88+
[This section is not required if you already covered considered alternatives in the design discussion above.]
89+
90+
####[Alternative 1]
91+
92+
[Describe an alternative which was considered, and why you decided against it.]
93+
94+
####[Alternative 2]
95+
96+
[etc.]
97+
98+
###Stakeholder Interest & Feedback
99+
100+
TODO before entering Phase 3.
101+
102+
[This should include a list of implementers who have expressed interest in implementing the proposal]
103+
104+
###References & acknowledgements
105+
106+
Many thanks for valuable feedback and advice from:
107+
108+
-[Person 1]
109+
-[Person 2]
110+
-[etc.]

‎proposal-template.abi.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
#Types
2+
3+
##<ahref="#api_type_one"name="api_type_one"></a>`api-type-one`: record
4+
5+
Short description
6+
7+
Explanation for developers using the API.
8+
9+
Size: 16, Alignment: 8
10+
11+
###Record Fields
12+
13+
- <ahref="api_type_one.property1"name="api_type_one.property1"></a>[`property1`](#api_type_one.property1):`u64`
14+
15+
16+
- <ahref="api_type_one.property2"name="api_type_one.property2"></a>[`property2`](#api_type_one.property2):`string`
17+
18+
19+
#Functions
20+
21+
----
22+
23+
####<ahref="#api_function_one"name="api_function_one"></a>`api-function-one`
24+
25+
Short description
26+
27+
Explanation for developers using the API.
28+
#####Results
29+
30+
- <ahref="#api_function_one."name="api_function_one."></a> ``:[`api-type-one`](#api_type_one)
31+

‎proposal-template.wit.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
#[Proposal Template] API
2+
3+
[This document contains the actual specification. It should be written in the WIT interface definition format. You can find more documentation on the WIT syntax (coming soon!).]
4+
5+
[Note that all comments inside of WIT code blocks will be included in the developer facing documentation for language bindings generated using this WIT file. If there is additional information that needs to be communicated to implementers of the API, then these should be captured in text directly below the code block.]
6+
7+
[If you want to include examples of the API in use, these should be in the README and linked to from this file.]
8+
9+
##api_type_one
10+
11+
```wit
12+
/// Short description
13+
///
14+
/// Explanation for developers using the API.
15+
record api-type-one {
16+
property1: u64,
17+
property2: string,
18+
}
19+
```
20+
21+
More rigorous specification details for the implementer go here, if needed.
22+
23+
##api_function_one
24+
25+
```wit
26+
/// Short description
27+
///
28+
/// Explanation for developers using the API.
29+
api-function-one: function() -> api-type-one
30+
```
31+
32+
If needed, this would explain what a compliant implementation MUST do, such as never returning an earlier result from a later call.

‎test/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
#Testing guidelines
2+
3+
TK fill in testing guidelines
4+
5+
##Installing the tools
6+
7+
TK fill in instructions
8+
9+
##Running the tests
10+
11+
TK fill in instructions

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp