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

[MISC] Updating issue templates #185

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

deusebio
Copy link
Contributor

@deusebio deusebio commented Apr 4, 2024

Introducing a new template for issues, based on this.

The new template introduces different templates for Bugs and Feature Requests. The required information for bugs are mostly still there but on dedicated text area.

I'd like to get a review from other teams such that we can hopefully stardardise this across the board.

Copy link
Contributor

@taurus-forever taurus-forever left a comment

Choose a reason for hiding this comment

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

LGTM, but it is a holly war like spaces VS tabs. I do not mind to use Canonical standard template... sign one with Maksim? :-)

P.S. At the moment all our repos uses identical template and I like this, if you are planning update, we should update all repos and not Kafka. Otherwise LGTM.

P.P.S. IMHO templates must sit here and be linked to all repos.

.github/ISSUE_TEMPLATE/BugReport.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/BugReport.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/BugReport.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/BugReport.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/BugReport.yml Outdated Show resolved Hide resolved
attributes:
label: "Notes & References"
description: "Please add relevant notes, links to mattermost chats,
other related issues/PRs, anything to help diagnose and solve the issue."
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need "Expected results" from reported?

My personal mandatory list:

  • STR (steps-to-reproduce)
  • Actual Results
  • Expected Results
  • Notes (version, logs, extra info ....)
    Like we had earlier :-)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, just I'm not sure Actual Results and Expected Results would always apply so I have created a required "Description" but optional behaviour forms

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.

None yet

2 participants