From 1be2ad72486f8282b1beb32fce586f9429ed5954 Mon Sep 17 00:00:00 2001 From: Gourav NSS Date: Fri, 3 Oct 2025 11:29:44 +0530 Subject: [PATCH 1/2] Fix GitHub issue template for documentation issues --- .github/ISSUE_TEMPLATE/good_first_issue_doc.yaml | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/good_first_issue_doc.yaml b/.github/ISSUE_TEMPLATE/good_first_issue_doc.yaml index c0568b2..d5531dd 100644 --- a/.github/ISSUE_TEMPLATE/good_first_issue_doc.yaml +++ b/.github/ISSUE_TEMPLATE/good_first_issue_doc.yaml @@ -8,15 +8,17 @@ body: value: | ## 👋 Thanks for contributing to MailLogSentinel! - ⚠️ **Code issues only** - for docs/tests, use the other templates + ⚠️ **Docs issues only** - for codes/tests, use the other templates **Perfect for**: first-time contributors, non-developers, improving adoption ⏱️ **Estimated time**: 1-3h | **No Python code required** 📖 Before you begin: - - [README](../blob/main/README.md) | [CONTRIBUTING](../blob/main/docs/CONTRIBUTING.md) | [Wiki](../wiki) - - [Code de conduite](../blob/main/CODE_OF_CONDUCT.md) + - [ ] [README](../blob/main/README.md) (optional) + - [ ] [CONTRIBUTING](../blob/main/docs/CONTRIBUTING.md) (mandatory) + - [ ] [Wiki](../wiki) (optional) + - [ ] [Code of conduct](../blob/main/CODE_OF_CONDUCT.md) (mandatory) - type: dropdown id: doc_type @@ -28,6 +30,8 @@ body: - "Code docstrings" - "Examples/Tutorials" - "FAQ/Troubleshooting" + - "Templates" + - "Others" validations: required: true @@ -70,7 +74,9 @@ body: id: files_to_modify attributes: label: "📋 Files to modify" - placeholder: "README.md, docs/setup.md, etc." + placeholder: "- [ ] README.md +- [ ] docs/setup.md +- [ ] etc." description: "Which files will be impacted?" - type: textarea From 548d708d3d87a8118bd016c3fa06d179507c8238 Mon Sep 17 00:00:00 2001 From: Gourav NSS Date: Mon, 6 Oct 2025 01:20:18 +0530 Subject: [PATCH 2/2] changes acc to prefrences --- .../ISSUE_TEMPLATE/good_first_issue_doc.yaml | 21 ++++++++++++------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/good_first_issue_doc.yaml b/.github/ISSUE_TEMPLATE/good_first_issue_doc.yaml index d5531dd..1d6d700 100644 --- a/.github/ISSUE_TEMPLATE/good_first_issue_doc.yaml +++ b/.github/ISSUE_TEMPLATE/good_first_issue_doc.yaml @@ -14,11 +14,17 @@ body: ⏱️ **Estimated time**: 1-3h | **No Python code required** - 📖 Before you begin: - - [ ] [README](../blob/main/README.md) (optional) - - [ ] [CONTRIBUTING](../blob/main/docs/CONTRIBUTING.md) (mandatory) - - [ ] [Wiki](../wiki) (optional) - - [ ] [Code of conduct](../blob/main/CODE_OF_CONDUCT.md) (mandatory) + - type: checkboxes + id: prerequisites + attributes: + label: "📖 Before you begin" + options: + - label: "README" + - label: "CONTRIBUTING" + required: true + - label: "Wiki" + - label: "Code of conduct" + required: true - type: dropdown id: doc_type @@ -31,6 +37,7 @@ body: - "Examples/Tutorials" - "FAQ/Troubleshooting" - "Templates" + - "Workflows" - "Others" validations: required: true @@ -74,9 +81,7 @@ body: id: files_to_modify attributes: label: "📋 Files to modify" - placeholder: "- [ ] README.md -- [ ] docs/setup.md -- [ ] etc." + placeholder: "README.md\ndocs/setup.md\netc." description: "Which files will be impacted?" - type: textarea