gravitino icon indicating copy to clipboard operation
gravitino copied to clipboard

[6582] fix: Broken Link in Issue Template Documentation

Open Brijeshthummar02 opened this issue 10 months ago • 2 comments

What changes were proposed in this pull request?

(Please outline the changes and how this PR fixes the issue.)

Why are the changes needed?

The link should direct users to the correct documentation on structured issue templates.

(Please clarify why the changes are needed. For instance,

  1. If you propose a new API, clarify the use case for a new API.
  2. If you fix a bug, describe the bug.)

Fix: #6582

Does this PR introduce any user-facing change?

no

(Please list the user-facing changes introduced by your change, including

  1. Change in user-facing APIs.
  2. Addition or removal of property keys.)

How was this patch tested?

(Please test your changes, and provide instructions on how to test it:

  1. If you add a feature or fix a bug, add a test to cover your changes.
  2. If you fix a flaky test, repeat it for many times to prove it works.)

Screenshot 2025-03-03 195000

Brijeshthummar02 avatar Mar 03 '25 14:03 Brijeshthummar02

Yes, it would be best to only include the URL change. I'm not 100% sure that the new URL is correct as it has what seems to be extra characters at the end. https://github.com/orgs/community/discussions/categories/issue-template-feedback%E2%80%94is

It may be best to use this: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository

Or just remove that comment.

justinmclean avatar Mar 04 '25 06:03 justinmclean

@Brijeshthummar02 would you please update your PR description to remove all the template words?

jerryshao avatar Mar 04 '25 11:03 jerryshao

@jerryshao good to go?

Brijeshthummar02 avatar Mar 05 '25 11:03 Brijeshthummar02

Well, I agree with @justinmclean on limiting the change to just the first line of the file. The link now works, that's good enough.

tengqm avatar Mar 05 '25 12:03 tengqm