Skip to content

Fix GitHub issue template for documentation issues #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
NssGourav wants to merge 2 commits into from
Closed

Fix GitHub issue template for documentation issues #30

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1be2ad7
Fix GitHub issue template for documentation issues
NssGourav Oct 3, 2025
548d708
changes acc to prefrences
NssGourav Oct 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions .github/ISSUE_TEMPLATE/good_first_issue_doc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,23 @@ 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)
- 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
Expand All @@ -28,6 +36,9 @@ body:
- "Code docstrings"
- "Examples/Tutorials"
- "FAQ/Troubleshooting"
- "Templates"
Comment thread
monozoide marked this conversation as resolved.
Comment thread
monozoide marked this conversation as resolved.
- "Workflows"
- "Others"
validations:
required: true

Expand Down Expand Up @@ -70,7 +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
Expand Down