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

chore : Update CRC GitHub issue template to be more interactive (#4494) #4495

Merged

Conversation

rohanKanojia
Copy link
Contributor

Description

Fixes: #4494

Relates to: #4494

CRC project is using quite old style issue template. Update it to be more interactive so that users can provide information easily.

You can check the preview of how it would look like here .

I've only ported relevant fields that were present in old template. If you think something else needs to be added, please add a comment on the pull request.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change
  • Chore (non-breaking change which doesn't affect codebase;
    test, version modification, documentation, etc.)

Proposed changes

Update GitHub Issue template to use new issue template format.

Testing

I've tested the template on my github fork. You can try it out here.

Contribution Checklist

  • I have read the contributing guidelines
  • My code follows the style guidelines of this project
  • I Keep It Small and Simple: The smaller the PR is, the easier it is to review and have it merged
  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I tested my code on specified platforms
    • Linux
    • Windows
    • MacOS

@openshift-ci openshift-ci bot requested review from gbraad and praveenkumar December 2, 2024 14:14
id: actual-behavior
attributes:
label: Actual behavior
description: A clear and concise description of what actually happen.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: happens

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for noticing, I copy pasted this template from Eclipse JKube.

.github/ISSUE_TEMPLATE/bug_report.yml Show resolved Hide resolved
blank_issues_enabled: true
contact_links:
- name: CRC IRC Community Chat (suitable for short, simple casual discussions)
url: https://freenode.net/
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this the right URL?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just used the same URL as provided in https://github.com/crc-org/crc?tab=readme-ov-file#community

I can change it to any other URL decided by the team.

Copy link
Contributor

Choose a reason for hiding this comment

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

No I mean the channel name is #codeready so there should be a clear direction to use that.

Copy link
Contributor

Choose a reason for hiding this comment

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

Didn't we move this to liberachat?
However nobody from the team is watching this channel as far as I know, so I'm not sure it is useful to mention it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@cfergeau : Shall I remove this list element?

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 with Rohan. I think we can remove this field

Copy link
Contributor

@gbraad gbraad Dec 9, 2024

Choose a reason for hiding this comment

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

We can always re-add after we made a decision in regard to #4506

@rohanKanojia rohanKanojia force-pushed the pr/improve-gh-issue-template branch from 5c03342 to 0cf8f14 Compare December 6, 2024 08:04
CRC project is using quite old style issue template. Update it to be
more interactive so that users can provide information easily.

Signed-off-by: Rohan Kumar <rohaan@redhat.com>
@rohanKanojia rohanKanojia force-pushed the pr/improve-gh-issue-template branch from 0cf8f14 to 23a7d28 Compare December 6, 2024 10:41
@vyasgun
Copy link
Contributor

vyasgun commented Dec 6, 2024

Looks good to me!

Copy link

openshift-ci bot commented Dec 6, 2024

@rohanKanojia: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-crc 23a7d28 link true /test e2e-crc

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@gbraad
Copy link
Contributor

gbraad commented Dec 9, 2024

/lgtm

Copy link

openshift-ci bot commented Dec 9, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: gbraad

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved label Dec 9, 2024
@gbraad gbraad merged commit d1fdbab into crc-org:main Dec 9, 2024
26 of 34 checks passed
@rohanKanojia rohanKanojia deleted the pr/improve-gh-issue-template branch December 9, 2024 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Doc] Improve github issue template to be more interactive
4 participants