Skip to content

[DOC] - Correction of the good_first_issue_doc template #28

Description

@monozoide

🎯 Type of documentation

Examples/Tutorials

🐛 Identified user problem

The Before you begin section needs changes: create a checkbox bullet list; the CONTRIBUTING and CODE OF CONDUCT boxes must be mandatory, not the others.


The DOC template has 2 errors:

  1. ⚠️ Code issues only - for docs/tests, use the other templates
  2. [Code de conduite](https://github.com/monozoide/MailLogSentinel/blob/main/CODE_OF_CONDUCT.md)

Also add to the Type of documentation dropdown:

  • Templates
  • Workflows
  • Others

📍 Target audience

users, contributors, maintainers

📋 Suggested content outline

  1. modify Before you begin : convert it into a checkbox with "contributing" and "code of conduct" as mandatory requirements
  2. fix the template .github/ISSUE_TEMPLATE/good_first_issue_doc.yaml
    • line 11: replace ⚠️ Code issues only - for docs/tests, use the other templates with ⚠️ Docs issues only - for codes/tests, use the other templates
    • line 19: replace [Code de conduite](https://github.com/monozoide/MailLogSentinel/blob/main/CODE_OF_CONDUCT.md) with [Code of conduct](https://github.com/monozoide/MailLogSentinel/blob/main/CODE_OF_CONDUCT.md)
    • line 30: add the following options: Templates, Workflow and Others
    • line 73: the example must be a checklist

📂 Expected deliverables

  • Text written in Markdown
  • Screenshots/examples if applicable
  • Links to external resources
  • Review by a test user

📋 Files to modify

.github/ISSUE_TEMPLATE/good_first_issue_doc.yaml

✅ How to validate the result

we will check it together

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions