Fix GitHub issue template for documentation issues#30
Fix GitHub issue template for documentation issues#30NssGourav wants to merge 2 commits intomonozoide:mainfrom
Conversation
monozoide
left a comment
There was a problem hiding this comment.
@NssGourav Can you make the changes? If anything is unclear, let me know!
|
|
||
| ⏱️ **Estimated time**: 1-3h | **No Python code required** | ||
|
|
||
| 📖 Before you begin: |
There was a problem hiding this comment.
In this checkbox, CONTRIBUTING and CODE OF CONDUCT must be mandatory. You can use the "required: true" property for both; the others are set to false.
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#checkboxes
| attributes: | ||
| label: "📋 Files to modify" | ||
| placeholder: "README.md, docs/setup.md, etc." | ||
| placeholder: "- [ ] README.md |
There was a problem hiding this comment.
the formatting is not correct, it should be a list
NssGourav
left a comment
There was a problem hiding this comment.
Made changes according to requirements
|
still open anything to addon ?? |
|
@NssGourav No, the merge is blocked because you didn't sign the commit. Signing is supposed to be mandatory, but since it wasn't specified, I set the |
🎯 Type of documentation
Examples / Tutorials
#28
🐛 Identified user problem
The "Before you begin" section needs changes: it should be a checkbox list, with CONTRIBUTING and CODE OF CONDUCT marked as mandatory.
The documentation template currently has two errors:
Code de conduite — should be Code of conduct.
Also, the Type of documentation dropdown should include:
📍 Target audience
Users
Contributors
Maintainers
📋 Suggested content outline / changes
Modify Before you begin: convert into a checkbox list with CONTRIBUTING and CODE OF CONDUCT as mandatory.
Fix the template .github/ISSUE_TEMPLATE/good_first_issue_doc.yaml:
📂 Expected deliverables
Markdown text for the updated template
Screenshots/examples (if applicable)
Links to external resources
Review feedback from a test user
📋 Files to modify
.github/ISSUE_TEMPLATE/good_first_issue_doc.yaml
✅ How to validate the result
We will check it together to ensure:
"Before you begin" section has proper checkboxes
Warning text shows "Docs issues only"
Dropdown options include Templates and Others
Example placeholder is a checklist
All text is in English