Skip to content

Commit f7cdc7a

Browse files
committed
Improve issue templates
1 parent cb2af5d commit f7cdc7a

3 files changed

Lines changed: 36 additions & 25 deletions

File tree

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,21 @@
11
---
2-
name: Bug report
3-
about: Create a bug report to help us improve
2+
name: Bug Report
3+
about: Create a bug report affecting the library
44
labels: "bug"
55
---
66

7-
## Summary
8-
A clear and concise description of the problem.
9-
10-
## Steps to Reproduce
11-
A minimal, complete and verifiable example (https://stackoverflow.com/help/mcve).
7+
<!-- WARNING: Ignoring this template will lead to the issue being closed as incomplete -->
128

13-
## Expected Results
14-
A description of what should happen.
9+
## Checklist
10+
- [ ] I am sure the error is coming from Pyrogram's code and not elsewhere.
11+
- [ ] I have searched in the issue tracker for similar bug reports, including closed ones.
12+
- [ ] I ran `pip3 install -U https://github.com/pyrogram/pyrogram/archive/develop.zip` and reproduced the issue using the latest development version.
1513

16-
## Actual Results
17-
A description of what actually happened.
18-
19-
## Environment info
20-
- **OS**: [e.g. Linux/macOS/Windows]
21-
- **Python version**: [e.g. 3.7.2]
22-
- **Pyrogram version**: [e.g. 0.12.0/develop]
14+
## Description
15+
A clear and concise description of the problem.
2316

24-
## Extra details
25-
Other details about the problem.
17+
## Steps to Reproduce
18+
[A minimal, complete and verifiable example](https://stackoverflow.com/help/mcve).
2619

27-
<details><summary><b>Logs</b>:</summary>
28-
Insert logs here (if necessary)
29-
</details>
20+
## Traceback
21+
The full traceback (if applicable).
Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
---
2-
name: Feature request
3-
about: Suggest a new feature or enhancement
2+
name: Feature Request
3+
about: Suggest ideas, new features or enhancements
44
labels: "enhancement"
55
---
6+
7+
<!-- WARNING: Ignoring this template will lead to the issue being closed as incomplete -->
8+
9+
## Checklist
10+
- [ ] I believe the idea is awesome and would benefit the library.
11+
- [ ] I have searched in the issue tracker for similar requests, including closed ones.
12+
13+
## Description
14+
A detailed description of the request.

.github/ISSUE_TEMPLATE/question.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
---
2-
name: Question
3-
about: Ask a question
2+
name: Ask Question
3+
about: Ask a Pyrogram related question
4+
title: For Q&A purposes, please read this template body
45
labels: "question"
56
---
7+
8+
<!-- WARNING: Ignoring this template will lead to the issue being closed as incomplete -->
9+
10+
# Important
11+
This place is for issues about Pyrogram, it's **not a forum**.
12+
13+
If you'd like to post a question, please move to https://stackoverflow.com or join the Telegram community by following the description in https://t.me/pyrogram.
14+
15+
Thanks.

0 commit comments

Comments
 (0)