From f7cdc7ac3c664b6506c915c9e38885ecb4670ef0 Mon Sep 17 00:00:00 2001 From: Dan <14043624+delivrance@users.noreply.github.com> Date: Sun, 12 May 2019 00:18:59 +0200 Subject: [PATCH] Improve issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 34 +++++++++-------------- .github/ISSUE_TEMPLATE/feature_request.md | 13 +++++++-- .github/ISSUE_TEMPLATE/question.md | 14 ++++++++-- 3 files changed, 36 insertions(+), 25 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 25c58a29..e0556d54 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,29 +1,21 @@ --- -name: Bug report -about: Create a bug report to help us improve +name: Bug Report +about: Create a bug report affecting the library labels: "bug" --- -## Summary + + +## Checklist +- [ ] I am sure the error is coming from Pyrogram's code and not elsewhere. +- [ ] I have searched in the issue tracker for similar bug reports, including closed ones. +- [ ] I ran `pip3 install -U https://github.com/pyrogram/pyrogram/archive/develop.zip` and reproduced the issue using the latest development version. + +## Description A clear and concise description of the problem. ## Steps to Reproduce -A minimal, complete and verifiable example (https://stackoverflow.com/help/mcve). +[A minimal, complete and verifiable example](https://stackoverflow.com/help/mcve). -## Expected Results -A description of what should happen. - -## Actual Results -A description of what actually happened. - -## Environment info -- **OS**: [e.g. Linux/macOS/Windows] -- **Python version**: [e.g. 3.7.2] -- **Pyrogram version**: [e.g. 0.12.0/develop] - -## Extra details -Other details about the problem. - -
Logs: -Insert logs here (if necessary) -
+## Traceback +The full traceback (if applicable). \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 6f6807b6..70a39192 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,5 +1,14 @@ --- -name: Feature request -about: Suggest a new feature or enhancement +name: Feature Request +about: Suggest ideas, new features or enhancements labels: "enhancement" --- + + + +## Checklist +- [ ] I believe the idea is awesome and would benefit the library. +- [ ] I have searched in the issue tracker for similar requests, including closed ones. + +## Description +A detailed description of the request. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md index fda9f94c..737304d9 100644 --- a/.github/ISSUE_TEMPLATE/question.md +++ b/.github/ISSUE_TEMPLATE/question.md @@ -1,5 +1,15 @@ --- -name: Question -about: Ask a question +name: Ask Question +about: Ask a Pyrogram related question +title: For Q&A purposes, please read this template body labels: "question" --- + + + +# Important +This place is for issues about Pyrogram, it's **not a forum**. + +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. + +Thanks. \ No newline at end of file