Skip to content

Enhance issue templates and enforce Code of Conduct - #25

Open
indpriyanshuraj wants to merge 2 commits into
wo55555:developfrom
indpriyanshuraj:feat/enhance-issue-templates
Open

Enhance issue templates and enforce Code of Conduct#25
indpriyanshuraj wants to merge 2 commits into
wo55555:developfrom
indpriyanshuraj:feat/enhance-issue-templates

Conversation

@indpriyanshuraj

Copy link
Copy Markdown
Contributor

ci: improve issue templates and enforce Code of Conduct

This PR improves the GitHub issue submission flow by adding dedicated contact links, Code of Conduct acknowledgment, and separate forms for documentation and translation issues.

Files changed

⚙️ config.yml

  • Enabled blank issues.
  • Added a Playback Discussions contact link.
  • Added an Installation and Usage Guide contact link.
  • Kept the existing Discord contact link unchanged.

🐛 1-bug_report.yml

  • Added a required Acknowledgements block.
  • Requires users to confirm that they searched existing issues for duplicates.
  • Requires users to acknowledge and agree to follow the Code of Conduct.

2-feature_request.yml

  • Added the same required Acknowledgements block as the bug report form.
  • Requires duplicate checking and Code of Conduct acknowledgment.

📖 3-documentation_issue.yml

Added a dedicated form for reporting:

  • Broken or incorrect links.
  • Outdated information or versions.
  • Incorrect instructions.
  • Typos.
  • Missing documentation.

Note

The form includes required location, issue description, and expected content fields, with optional additional context.

  • Label: documentation & enhancement
  • Title prefix: [Docs]

🌐 4-translation_issue.yml

Added a dedicated form for:

  • Untranslated strings.
  • Incorrect translations.
  • Translation typos.
  • Hardcoded strings.
  • New language contributions.

Note

The form uses free-text fields for language and location so it does not require maintenance when supported languages or documentation locations change.

  • Label: enhancement
  • Title prefix: [Translation]

Important

This PR only changes GitHub repository configuration and issue templates. It does not modify Playback source code or runtime behavior.

Enable blank issues and add Discussions,and docs to config.yml

Add Code of Conduct acceptance checkbox to bug report and feature request forms

Add documentation issue form

Add translation issue form

Signed-off-by: indpriyanshuraj <243560345+indpriyanshuraj@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant