From 24582a5e16e2221bf65c22da5bbc848ef1812c51 Mon Sep 17 00:00:00 2001 From: bia-pain-bache Date: Thu, 4 Jul 2024 13:54:34 +0330 Subject: [PATCH] Added custom bug report template. --- .github/ISSUE_TEMPLATE/bug_report.yml | 42 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 +++ .github/ISSUE_TEMPLATE/feature_request.yml | 16 +++++++++ .gitignore | 4 ++- 4 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..c33280e91 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,42 @@ +name: Bug Report +description: Report a bug encountered while using BPB Panel +body: + - type: markdown + attributes: + value: | + Please make sure to provide a descriptive report. It saves time for both the developer and users who are looking for solutions. Providing as much information as possible, including screenshots and logs, is highly appreciated. This will help us to better understand the issue and respond more effectively. + لطفا مطمئن شوید که گزارشی تشریحی ارائه دهید. این باعث می‌شود که توسعه‌دهنده و کاربرانی که در جستجوی راهکارها هستند، زمان کمتری صرف کنند. ارائه اطلاعات بیشتر از جمله اسکرین‌شات و لاگ توصیه می‌شود. این باعث می‌شود که ما بهتر بتوانیم مشکل را درک کرده و به‌صورت بهتر پاسخ دهیم. + - type: checkboxes + id: confirm-search + attributes: + label: Attention | توجه + description: Please search [existing issues](https://github.com/bia-pain-bache/BPB-Worker-Panel/issues) before reporting | لطفا قبل از ارسال گزارش [ایشوهای موجود](https://github.com/bia-pain-bache/BPB-Worker-Panel/issues) را بررسی کنید. + options: + - label: I searched and no similar issues were found | جستجو کردم و هیچ گزارش مشابهی پیدا نشد + required: true + - type: textarea + id: problem + attributes: + label: What Happened? | چه اتفاقی افتاده؟ + description: | + Please provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner. + لطفاً اطلاعات کاملی را ارائه دهید. اگر این کار را انجام ندهید، ممکن است مشکل شما به صورت تمام شده تلقی شده یا در زمان مناسبی بررسی نشود. + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Minimal Reproducible Example | چه پروسه‌ای برای مشاهده این مشکل طی کرده‌اید؟ + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + - type: textarea + id: logs + attributes: + label: Relevant log output | لاگ برنامه یا پنل + description: Refer to the program menu and copy the log and send it to us. + render: shell + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..e36b27f76 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: FAQ | سوالات متداول + url: https://github.com/bia-pain-bache/BPB-Worker-Panel/blob/main/docs/faq.md + about: Before asking a question or presenting a problem, read through the frequently asked questions. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..1e18f2a53 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,16 @@ +name: Feature Request +description: Request a new feature +labels: ['enhancement'] + +body: + - type: markdown + attributes: + value: | + Here is a template you can use to share your idea. + اینجا می‌توانید ایده خود به اشتراک بگذارید. + - type: textarea + attributes: + label: Feature description | توضیحات ویژگی + description: Please provide a clear and concise description of what you want to happen and what problem will this solve | لطفاً توضیحات روشن و کوتاهی از آنچه که می‌خواهید رخ دهد و مشکلی که پیش می‌آید را حل کنید، ارائه دهید. + validations: + required: true \ No newline at end of file diff --git a/.gitignore b/.gitignore index 75b9f2571..df4ab7977 100644 --- a/.gitignore +++ b/.gitignore @@ -6,4 +6,6 @@ !location.json !_worker.js !docs/ -!docs/assets/images \ No newline at end of file +!docs/** +!.github/ +!.github/** \ No newline at end of file