Skip to content

Commit 001cc6f

Browse files
seefloodseeflood
authored
chore: improve issue templates && generator templates (#841)
1 parent 959bb1d commit 001cc6f

File tree

26 files changed

+126
-1355
lines changed

26 files changed

+126
-1355
lines changed

‎.github/ISSUE_TEMPLATE/good-first-issue-component.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,16 @@ For example, you can choose any one in the list below:
2222
- [ ] Mongo
2323
- [ ] Mysql
2424
- [ ] Postgresql
25-
- [ ] MinIO
2625
- [ ] Cassandra
26+
- [ ] MinIO
27+
- [ ] Ceph
28+
- [ ] Alibaba Cloud OSS
29+
- [ ] AWS S3
30+
- [ ] Kafka
31+
- [ ] RabbitMQ
32+
- [ ] RocketMQ
33+
- [ ] ActiveMQ
34+
- [ ] RabbitMQ
2735
- [ ] Cloud service provided by Alibaba cloud
2836
- [ ] Cloud service provided by AWS
2937
- [ ] Cloud service provided by Azure
@@ -34,16 +42,22 @@ For example, you can choose any one in the list below:
3442

3543
**Reference(FIXME)**:
3644

37-
An example pull request :
45+
Here are some resources to help you work on this issue.
3846

3947
API quickstart doc:
4048

41-
API reference:
49+
API definition(the `.proto` file):
50+
51+
Component development guide: https://mosn.io/layotto/#/en/development/developing-component
52+
53+
Component development guide(in chinese): https://mosn.io/layotto/#/zh/development/developing-component
54+
55+
An example pull request to develop a new component:
4256

4357
API design doc/discussion:
4458

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

4963

‎.github/ISSUE_TEMPLATE/good-first-issue-go-demo.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: "Good first issue (develop a golang demo)"
3+
about: Submit a good first issue
4+
labels: ["kind/demo", "help wanted","good first issue","easy" ]
5+
title: "Develop a golang demo for XXX API; 为 XXX API 开发一个 golang demo"
6+
7+
---
8+
<!-- Please only use this template for submitting good first issues -->
9+
10+
**What would you like to be added**:
11+
12+
Develop a golang demo for **(FIXME) XXX** API.
13+
14+
Now we already have quickstart docs for this API, and we need a demo to show users how to invoke this API.
15+
16+
You can take the [lock api quickstart](https://mosn.io/layotto/#/en/start/lock/start) as an example:
17+
18+
![image](https://user-images.githubusercontent.com/26001097/199906600-d4c92b5e-7b93-4e61-96ca-91c9d96edc04.png)
19+
20+
The golang demo of lock api is [here](https://github.com/mosn/layotto/blob/main/demo/lock/common/client.go).
21+
22+
**Reference**:
23+
24+
Here are some resources to help you work on this issue.
25+
26+
Quickstart doc for this API:
27+
28+
API definition (the .proto file):
29+
30+
golang sdk: https://github.com/mosn/layotto/tree/main/sdk/go-sdk
31+
32+
API design doc/discussion:
33+
34+
**Why is this needed**:
35+
36+
Golang users need it

‎.github/ISSUE_TEMPLATE/good-first-issue-java-demo.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
name: "Good first issue (develop a java demo)"
3+
about: Submit a good first issue
4+
labels: ["kind/demo", "help wanted","good first issue","easy" ]
5+
title: "Develop a java demo for XXX API; 为 XXX API 开发一个 java demo"
6+
7+
---
8+
<!-- Please only use this template for submitting good first issues -->
9+
10+
**What would you like to be added**:
11+
12+
Develop a java demo for **(FIXME) XXX** API.
13+
14+
Now we already have quickstart docs for this API, and we need a demo to show users how to invoke this API.
15+
16+
You can take the [lock api quickstart](https://mosn.io/layotto/#/en/start/lock/start) as an example:
17+
18+
![image](https://user-images.githubusercontent.com/26001097/199906799-ac30da05-c983-408b-b0e9-2fd712ec492f.png)
19+
20+
The java demo of lock api is [here](https://github.com/layotto/java-sdk/tree/main/examples-lock).
21+
22+
**Reference**:
23+
24+
Here are some resources to help you work on this issue.
25+
26+
Quickstart doc for this API:
27+
28+
API definition (the .proto file):
29+
30+
java sdk: https://github.com/layotto/java-sdk
31+
32+
API design doc/discussion:
33+
34+
**Why is this needed**:
35+
36+
Java users need it.

‎docs/api/v1/cryption.html

-189
Original file line numberDiff line numberDiff line change
@@ -398,194 +398,5 @@ <h3 id="spec.proto.extension.v1.cryption.EncryptResponse">EncryptResponse</h3>
398398

399399

400400

401-
<h2 id="scalar-value-types">Scalar Value Types</h2>
402-
<table class="scalar-value-types-table">
403-
<thead>
404-
<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>
405-
</thead>
406-
<tbody>
407-
408-
<tr id="double">
409-
<td>double</td>
410-
<td></td>
411-
<td>double</td>
412-
<td>double</td>
413-
<td>float</td>
414-
<td>float64</td>
415-
<td>double</td>
416-
<td>float</td>
417-
<td>Float</td>
418-
</tr>
419-
420-
<tr id="float">
421-
<td>float</td>
422-
<td></td>
423-
<td>float</td>
424-
<td>float</td>
425-
<td>float</td>
426-
<td>float32</td>
427-
<td>float</td>
428-
<td>float</td>
429-
<td>Float</td>
430-
</tr>
431-
432-
<tr id="int32">
433-
<td>int32</td>
434-
<td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.</td>
435-
<td>int32</td>
436-
<td>int</td>
437-
<td>int</td>
438-
<td>int32</td>
439-
<td>int</td>
440-
<td>integer</td>
441-
<td>Bignum or Fixnum (as required)</td>
442-
</tr>
443-
444-
<tr id="int64">
445-
<td>int64</td>
446-
<td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.</td>
447-
<td>int64</td>
448-
<td>long</td>
449-
<td>int/long</td>
450-
<td>int64</td>
451-
<td>long</td>
452-
<td>integer/string</td>
453-
<td>Bignum</td>
454-
</tr>
455-
456-
<tr id="uint32">
457-
<td>uint32</td>
458-
<td>Uses variable-length encoding.</td>
459-
<td>uint32</td>
460-
<td>int</td>
461-
<td>int/long</td>
462-
<td>uint32</td>
463-
<td>uint</td>
464-
<td>integer</td>
465-
<td>Bignum or Fixnum (as required)</td>
466-
</tr>
467-
468-
<tr id="uint64">
469-
<td>uint64</td>
470-
<td>Uses variable-length encoding.</td>
471-
<td>uint64</td>
472-
<td>long</td>
473-
<td>int/long</td>
474-
<td>uint64</td>
475-
<td>ulong</td>
476-
<td>integer/string</td>
477-
<td>Bignum or Fixnum (as required)</td>
478-
</tr>
479-
480-
<tr id="sint32">
481-
<td>sint32</td>
482-
<td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.</td>
483-
<td>int32</td>
484-
<td>int</td>
485-
<td>int</td>
486-
<td>int32</td>
487-
<td>int</td>
488-
<td>integer</td>
489-
<td>Bignum or Fixnum (as required)</td>
490-
</tr>
491-
492-
<tr id="sint64">
493-
<td>sint64</td>
494-
<td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.</td>
495-
<td>int64</td>
496-
<td>long</td>
497-
<td>int/long</td>
498-
<td>int64</td>
499-
<td>long</td>
500-
<td>integer/string</td>
501-
<td>Bignum</td>
502-
</tr>
503-
504-
<tr id="fixed32">
505-
<td>fixed32</td>
506-
<td>Always four bytes. More efficient than uint32 if values are often greater than 2^28.</td>
507-
<td>uint32</td>
508-
<td>int</td>
509-
<td>int</td>
510-
<td>uint32</td>
511-
<td>uint</td>
512-
<td>integer</td>
513-
<td>Bignum or Fixnum (as required)</td>
514-
</tr>
515-
516-
<tr id="fixed64">
517-
<td>fixed64</td>
518-
<td>Always eight bytes. More efficient than uint64 if values are often greater than 2^56.</td>
519-
<td>uint64</td>
520-
<td>long</td>
521-
<td>int/long</td>
522-
<td>uint64</td>
523-
<td>ulong</td>
524-
<td>integer/string</td>
525-
<td>Bignum</td>
526-
</tr>
527-
528-
<tr id="sfixed32">
529-
<td>sfixed32</td>
530-
<td>Always four bytes.</td>
531-
<td>int32</td>
532-
<td>int</td>
533-
<td>int</td>
534-
<td>int32</td>
535-
<td>int</td>
536-
<td>integer</td>
537-
<td>Bignum or Fixnum (as required)</td>
538-
</tr>
539-
540-
<tr id="sfixed64">
541-
<td>sfixed64</td>
542-
<td>Always eight bytes.</td>
543-
<td>int64</td>
544-
<td>long</td>
545-
<td>int/long</td>
546-
<td>int64</td>
547-
<td>long</td>
548-
<td>integer/string</td>
549-
<td>Bignum</td>
550-
</tr>
551-
552-
<tr id="bool">
553-
<td>bool</td>
554-
<td></td>
555-
<td>bool</td>
556-
<td>boolean</td>
557-
<td>boolean</td>
558-
<td>bool</td>
559-
<td>bool</td>
560-
<td>boolean</td>
561-
<td>TrueClass/FalseClass</td>
562-
</tr>
563-
564-
<tr id="string">
565-
<td>string</td>
566-
<td>A string must always contain UTF-8 encoded or 7-bit ASCII text.</td>
567-
<td>string</td>
568-
<td>String</td>
569-
<td>str/unicode</td>
570-
<td>string</td>
571-
<td>string</td>
572-
<td>string</td>
573-
<td>String (UTF-8)</td>
574-
</tr>
575-
576-
<tr id="bytes">
577-
<td>bytes</td>
578-
<td>May contain any arbitrary sequence of bytes.</td>
579-
<td>string</td>
580-
<td>ByteString</td>
581-
<td>str</td>
582-
<td>[]byte</td>
583-
<td>ByteString</td>
584-
<td>string</td>
585-
<td>String (ASCII-8BIT)</td>
586-
</tr>
587-
588-
</tbody>
589-
</table>
590401
</body>
591402
</html>

0 commit comments

Comments
 (0)