Skip to content

Commit

Permalink
chore: improve issue templates && generator templates (#841)
Browse files Browse the repository at this point in the history
  • Loading branch information
@seeflood
seeflood authored Nov 4, 2022
1 parent 959bb1d commit 001cc6f
Show file tree
Hide file tree
Showing 26 changed files with 126 additions and 1,355 deletions.
22 changes: 18 additions & 4 deletions .github/ISSUE_TEMPLATE/good-first-issue-component.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,16 @@ For example, you can choose any one in the list below:
- [ ] Mongo
- [ ] Mysql
- [ ] Postgresql
- [ ] MinIO
- [ ] Cassandra
- [ ] MinIO
- [ ] Ceph
- [ ] Alibaba Cloud OSS
- [ ] AWS S3
- [ ] Kafka
- [ ] RabbitMQ
- [ ] RocketMQ
- [ ] ActiveMQ
- [ ] RabbitMQ
- [ ] Cloud service provided by Alibaba cloud
- [ ] Cloud service provided by AWS
- [ ] Cloud service provided by Azure
Expand All @@ -34,16 +42,22 @@ For example, you can choose any one in the list below:

**Reference(FIXME)**:

An example pull request :
Here are some resources to help you work on this issue.

API quickstart doc:

API reference:
API definition(the `.proto` file):

Component development guide: https://mosn.io/layotto/#/en/development/developing-component

Component development guide(in chinese): https://mosn.io/layotto/#/zh/development/developing-component

An example pull request to develop a new component:

API design doc/discussion:

chinese:
选择一个你喜欢的开源组件或云服务实现**XXX API(FIXME)**,
选择一个你喜欢的开源组件或云服务实现 **(FIXME) XXX** API,
参考资料见上。


Expand Down
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/good-first-issue-go-demo.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: "Good first issue (develop a golang demo)"
about: Submit a good first issue
labels: ["kind/demo", "help wanted","good first issue","easy" ]
title: "Develop a golang demo for XXX API; 为 XXX API 开发一个 golang demo"

---
<!-- Please only use this template for submitting good first issues -->

**What would you like to be added**:

Develop a golang demo for **(FIXME) XXX** API.

Now we already have quickstart docs for this API, and we need a demo to show users how to invoke this API.

You can take the [lock api quickstart](https://mosn.io/layotto/#/en/start/lock/start) as an example:

![image](https://user-images.githubusercontent.com/26001097/199906600-d4c92b5e-7b93-4e61-96ca-91c9d96edc04.png)

The golang demo of lock api is [here](https://github.com/mosn/layotto/blob/main/demo/lock/common/client.go).

**Reference**:

Here are some resources to help you work on this issue.

Quickstart doc for this API:

API definition (the .proto file):

golang sdk: https://github.com/mosn/layotto/tree/main/sdk/go-sdk

API design doc/discussion:

**Why is this needed**:

Golang users need it
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/good-first-issue-java-demo.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
name: "Good first issue (develop a java demo)"
about: Submit a good first issue
labels: ["kind/demo", "help wanted","good first issue","easy" ]
title: "Develop a java demo for XXX API; 为 XXX API 开发一个 java demo"

---
<!-- Please only use this template for submitting good first issues -->

**What would you like to be added**:

Develop a java demo for **(FIXME) XXX** API.

Now we already have quickstart docs for this API, and we need a demo to show users how to invoke this API.

You can take the [lock api quickstart](https://mosn.io/layotto/#/en/start/lock/start) as an example:

![image](https://user-images.githubusercontent.com/26001097/199906799-ac30da05-c983-408b-b0e9-2fd712ec492f.png)

The java demo of lock api is [here](https://github.com/layotto/java-sdk/tree/main/examples-lock).

**Reference**:

Here are some resources to help you work on this issue.

Quickstart doc for this API:

API definition (the .proto file):

java sdk: https://github.com/layotto/java-sdk

API design doc/discussion:

**Why is this needed**:

Java users need it.
189 changes: 0 additions & 189 deletions docs/api/v1/cryption.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -398,194 +398,5 @@ <h3 id="spec.proto.extension.v1.cryption.EncryptResponse">EncryptResponse</h3>



<h2 id="scalar-value-types">Scalar Value Types</h2>
<table class="scalar-value-types-table">
<thead>
<tr><td>.proto Type</td><td>Notes</td><td>C++</td><td>Java</td><td>Python</td><td>Go</td><td>C#</td><td>PHP</td><td>Ruby</td></tr>
</thead>
<tbody>

<tr id="double">
<td>double</td>
<td></td>
<td>double</td>
<td>double</td>
<td>float</td>
<td>float64</td>
<td>double</td>
<td>float</td>
<td>Float</td>
</tr>

<tr id="float">
<td>float</td>
<td></td>
<td>float</td>
<td>float</td>
<td>float</td>
<td>float32</td>
<td>float</td>
<td>float</td>
<td>Float</td>
</tr>

<tr id="int32">
<td>int32</td>
<td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.</td>
<td>int32</td>
<td>int</td>
<td>int</td>
<td>int32</td>
<td>int</td>
<td>integer</td>
<td>Bignum or Fixnum (as required)</td>
</tr>

<tr id="int64">
<td>int64</td>
<td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.</td>
<td>int64</td>
<td>long</td>
<td>int/long</td>
<td>int64</td>
<td>long</td>
<td>integer/string</td>
<td>Bignum</td>
</tr>

<tr id="uint32">
<td>uint32</td>
<td>Uses variable-length encoding.</td>
<td>uint32</td>
<td>int</td>
<td>int/long</td>
<td>uint32</td>
<td>uint</td>
<td>integer</td>
<td>Bignum or Fixnum (as required)</td>
</tr>

<tr id="uint64">
<td>uint64</td>
<td>Uses variable-length encoding.</td>
<td>uint64</td>
<td>long</td>
<td>int/long</td>
<td>uint64</td>
<td>ulong</td>
<td>integer/string</td>
<td>Bignum or Fixnum (as required)</td>
</tr>

<tr id="sint32">
<td>sint32</td>
<td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.</td>
<td>int32</td>
<td>int</td>
<td>int</td>
<td>int32</td>
<td>int</td>
<td>integer</td>
<td>Bignum or Fixnum (as required)</td>
</tr>

<tr id="sint64">
<td>sint64</td>
<td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.</td>
<td>int64</td>
<td>long</td>
<td>int/long</td>
<td>int64</td>
<td>long</td>
<td>integer/string</td>
<td>Bignum</td>
</tr>

<tr id="fixed32">
<td>fixed32</td>
<td>Always four bytes. More efficient than uint32 if values are often greater than 2^28.</td>
<td>uint32</td>
<td>int</td>
<td>int</td>
<td>uint32</td>
<td>uint</td>
<td>integer</td>
<td>Bignum or Fixnum (as required)</td>
</tr>

<tr id="fixed64">
<td>fixed64</td>
<td>Always eight bytes. More efficient than uint64 if values are often greater than 2^56.</td>
<td>uint64</td>
<td>long</td>
<td>int/long</td>
<td>uint64</td>
<td>ulong</td>
<td>integer/string</td>
<td>Bignum</td>
</tr>

<tr id="sfixed32">
<td>sfixed32</td>
<td>Always four bytes.</td>
<td>int32</td>
<td>int</td>
<td>int</td>
<td>int32</td>
<td>int</td>
<td>integer</td>
<td>Bignum or Fixnum (as required)</td>
</tr>

<tr id="sfixed64">
<td>sfixed64</td>
<td>Always eight bytes.</td>
<td>int64</td>
<td>long</td>
<td>int/long</td>
<td>int64</td>
<td>long</td>
<td>integer/string</td>
<td>Bignum</td>
</tr>

<tr id="bool">
<td>bool</td>
<td></td>
<td>bool</td>
<td>boolean</td>
<td>boolean</td>
<td>bool</td>
<td>bool</td>
<td>boolean</td>
<td>TrueClass/FalseClass</td>
</tr>

<tr id="string">
<td>string</td>
<td>A string must always contain UTF-8 encoded or 7-bit ASCII text.</td>
<td>string</td>
<td>String</td>
<td>str/unicode</td>
<td>string</td>
<td>string</td>
<td>string</td>
<td>String (UTF-8)</td>
</tr>

<tr id="bytes">
<td>bytes</td>
<td>May contain any arbitrary sequence of bytes.</td>
<td>string</td>
<td>ByteString</td>
<td>str</td>
<td>[]byte</td>
<td>ByteString</td>
<td>string</td>
<td>String (ASCII-8BIT)</td>
</tr>

</tbody>
</table>
</body>
</html>
Loading

0 comments on commit 001cc6f

Please sign in to comment.