Skip to content

templates: Improve GitHub issue templates. #1572

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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sundanc
Copy link

@sundanc sundanc commented Apr 2, 2025

What does this PR do, and why?

This PR improves the GitHub issue templates by adding more comprehensive sections that help users provide better context for their reports. Each template now includes:

  • A "Potential challenges or limitations" section in the platform feature template to encourage contributors to think about edge cases
  • An "Impact on user experience" section in the feature parity template to highlight how users are affected
  • A "Logs or additional context" section in the bug report template to facilitate debugging
  • A "Frequency of occurrence" section in crash reports to help prioritize issues
  • A "Documentation updates" section in the PR template to remind contributors about documentation needs

These additions help gather more complete information upfront, making it easier for maintainers to understand, prioritize, and address issues.

External discussion & connections

  • Discussed in #zulip-terminal in template-improvements
  • Fully fixes #
  • Partially fixes issue #
  • Builds upon previous unmerged work in PR #
  • Is a follow-up to work in PR #
  • Requires merge of PR #
  • Merge will enable work on #

How did you test this?

  • Manually - Visual changes
  • Manually - Behavioral changes
  • Adapting existing automated tests
  • Adding automated tests for new behavior (or missing tests)
  • Existing automated tests should already cover this (only a refactor of tested code)

Self-review checklist for each commit

  • It is a minimal coherent idea
  • It has a commit summary following the documented style (title & body)
  • It has a commit summary describing the motivation and reasoning for the change
  • It individually passes linting and tests
  • It contains test additions for any new behavior
  • It flows clearly from a previous branch commit, and/or prepares for the next commit

@zulipbot zulipbot added the size: S [Automatic label added by zulipbot] label Apr 2, 2025
@neiljp neiljp added the PR needs review PR requires feedback to proceed label Apr 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR needs review PR requires feedback to proceed size: S [Automatic label added by zulipbot]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants