Skip to content
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

Update issue templates to refer to obtaining About/Exception details [Enhancement] #1559

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

Conversation

Itz-Agasta
Copy link
Collaborator

@Itz-Agasta Itz-Agasta commented Dec 11, 2024

What does this PR do, and why?

Drafted the updated issue templates as discussed in #1548 . It now includes instructions for using the "Copy" option in the About and Exception popups, as well as guidance on referencing relevant log files (zulip-terminal-tracebacks.log and debug.log).
closes #1548

Outstanding aspect(s)

  • "How are you running the application?" section works well with the instructions I added for pasting the information, or would it be better to move those instructions into a separate section?

External discussion & connections

How did you test this?

  • Manually - Behavioral changes
  • Manually - Visual 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 Dec 11, 2024
@zulipbot
Copy link
Member

Hello @Itz-Agasta, it seems like you have referenced #1548 in your pull request description, but you have not referenced them in your commit message description(s). Referencing an issue in a commit message automatically closes the corresponding issue when the commit is merged, which makes the issue tracker easier to manage.

Please run git commit --amend in your command line client to amend your commit message description with Fixes #1548..

An example of a correctly-formatted commit:

commit fabd5e450374c8dde65ec35f02140383940fe146
Author: zulipbot
Date:   Sat Mar 18 13:42:40 2017 -0700

    pull requests: Check PR commits reference when issue is referenced.

    Fixes #51.

To learn how to write a great commit message, please refer to our guide.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size: S [Automatic label added by zulipbot]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update issue templates to refer to obtaining About/Exception details
2 participants