Skip to content

Comments

Fix GitHub issue template for documentation issues#30

Closed
NssGourav wants to merge 2 commits intomonozoide:mainfrom
NssGourav:#28
Closed

Fix GitHub issue template for documentation issues#30
NssGourav wants to merge 2 commits intomonozoide:mainfrom
NssGourav:#28

Conversation

@NssGourav
Copy link

@NssGourav NssGourav commented Oct 3, 2025

🎯 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 issues only — should be Docs issues only.

Code de conduite — should be Code of conduct.

Also, the Type of documentation dropdown should include:

  • Templates
  • Workflows
  • Others

📍 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:

  1. Line 11: replace ⚠️ Code issues only - for docs/tests, use the other templates → ⚠️ Docs issues only - for codes/tests, use the other templates.
  2. Line 19: replace [Code de conduite] → [Code of conduct].
  3. Line 30: add dropdown options: Templates and Others.
  4. Line 73: change the example placeholder to checklist format.

📂 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

@monozoide monozoide self-requested a review October 5, 2025 18:43
@monozoide monozoide added the documentation Improvements or additions to documentation label Oct 5, 2025
@monozoide monozoide moved this to In review in Hacktoberfest 2025 Oct 5, 2025
Copy link
Owner

@monozoide monozoide left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NssGourav Can you make the changes? If anything is unclear, let me know!


⏱️ **Estimated time**: 1-3h | **No Python code required**

📖 Before you begin:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure on it

attributes:
label: "📋 Files to modify"
placeholder: "README.md, docs/setup.md, etc."
placeholder: "- [ ] README.md
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the formatting is not correct, it should be a list

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh okay!

@monozoide monozoide moved this from In review to needs-changes in Hacktoberfest 2025 Oct 5, 2025
Copy link
Author

@NssGourav NssGourav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Made changes according to requirements

@monozoide monozoide linked an issue Oct 5, 2025 that may be closed by this pull request
4 tasks
Copy link
Owner

@monozoide monozoide left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thx!

@monozoide monozoide moved this from needs-changes to In review in Hacktoberfest 2025 Oct 5, 2025
@monozoide monozoide added the Hacktoberfest-accepted Accepted Issues & PRs for Hacktoberfest 2025 label Oct 5, 2025
@NssGourav
Copy link
Author

still open anything to addon ??

@monozoide
Copy link
Owner

@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 hacktoberfest-accepted label and will figure it out later.

@monozoide monozoide moved this from In review to Done in Hacktoberfest 2025 Oct 10, 2025
@monozoide monozoide closed this Oct 10, 2025
@NssGourav NssGourav deleted the #28 branch October 10, 2025 09:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Hacktoberfest-accepted Accepted Issues & PRs for Hacktoberfest 2025

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

[DOC] - Correction of the good_first_issue_doc template

2 participants