Skip to content

Commit 90498ba

Browse files
committed
Doc, update github bug report template
1 parent 66c0472 commit 90498ba

File tree

1 file changed

+56
-17
lines changed

1 file changed

+56
-17
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 56 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,68 @@ assignees: ''
1010
**Describe the bug**
1111
A clear and concise description of what the bug is.
1212

13-
**To Reproduce**
14-
Steps to reproduce the behavior:
15-
1. Go to '...'
16-
2. Click on '....'
17-
3. Scroll down to '....'
18-
4. See error
13+
14+
**Dependencies**
15+
16+
> Input cmd:
17+
> ```bash
18+
> python -m protobuf_to_pydantic --info
19+
> # OR
20+
> python -m protobuf_to_pydantic.plugin --info
21+
> ```
22+
23+
> Result:
24+
> ```bash
25+
> # Paste the output of the command here
26+
> ```
27+
28+
**Protobuf File Content**
29+
30+
> Please check the Protobuf content for sensitive information
31+
32+
> Example:
33+
> Filename: `path1/demo1.proto`
34+
> ```protobuf
35+
> package demo1;
36+
>
37+
> message Demo1{};
38+
> ```
39+
>
40+
> Filename: `path2/demo2.proto`
41+
> ```protobuf
42+
> package demo2;
43+
>
44+
> message Demo2{};
45+
> ```
46+
47+
**CLI(if use plugin mode)**
48+
> Example:
49+
> ```bash
50+
> python -m grpc_tools.protoc -I. --protobuf-to-pydantic_out=config_path=plugin_config.py:. example.proto
51+
> ```
52+
53+
**Output content**
54+
55+
> Example:
56+
> Filename: `path1/demo1.p2p`
57+
> ```python
58+
> class Demo1(BaseModel):
59+
> pass
60+
> ```
61+
>
62+
> Filename: `path2/demo2.p2p`
63+
> ```python
64+
> class Demo2(BaseModel):
65+
> pass
66+
> ```
67+
68+
1969
2070
**Expected behavior**
2171
A clear and concise description of what you expected to happen.
2272
2373
**Screenshots**
2474
If applicable, add screenshots to help explain your problem.
2575
26-
**Desktop (please complete the following information):**
27-
- OS: [e.g. iOS]
28-
- Browser [e.g. chrome, safari]
29-
- Version [e.g. 22]
30-
31-
**Smartphone (please complete the following information):**
32-
- Device: [e.g. iPhone6]
33-
- OS: [e.g. iOS8.1]
34-
- Browser [e.g. stock browser, safari]
35-
- Version [e.g. 22]
36-
3776
**Additional context**
3877
Add any other context about the problem here.

0 commit comments

Comments
 (0)