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

Add better template for issues #18737

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

Conversation

Vad1mo
Copy link
Member

@Vad1mo Vad1mo commented May 25, 2023

This PR will bring better template for new issues, to better guide users through the process of creating good and understandable issues.

Please indicate you've done the following:

  • Well Written Title and Summary of the PR
  • Label the PR as "release-note/infra"
  • Accepted the DCO. Commits without the DCO will delay acceptance.
  • Made sure tests are passing and test coverage is added if needed.
  • Considered the docs impact and opened a new docs issue or PR with docs changes if needed in website repository.

@Vad1mo Vad1mo requested a review from a team as a code owner May 25, 2023 15:28
@Vad1mo Vad1mo added the release-note/infra Infra related changes e.g. release, test, ship etc... label May 25, 2023
@Vad1mo Vad1mo force-pushed the feature/better_issue_templates branch from b40b992 to 9b3eaf9 Compare May 25, 2023 15:29
---
<!--
Remember, an issue is not the place to ask questions. You can use [Stack Overflow](https://stackoverflow.com/questions/tagged/harbor) for that, or you may want to start a discussion in [Slack](https://cloud-native.slack.com/archives/CC1E09J6S).
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 actually recommend users to use Stack Overflow? IMO, it would be more appropriate to simply state that Slack is the primary and recommended channel for support.

Copy link
Member

Choose a reason for hiding this comment

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

as we do not monitor stack overflow I suggest we remove it

Copy link
Member

Choose a reason for hiding this comment

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

or add that you can receive community help from there!

Copy link
Contributor

Choose a reason for hiding this comment

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

updates?

@github-actions
Copy link

This PR is being marked stale due to a period of inactivty. If this PR is still relevant, please comment or remove the stale label. Otherwise, this PR will close in 30 days.

@github-actions github-actions bot added the Stale label Jul 28, 2023
@Vad1mo Vad1mo removed the Stale label Aug 25, 2023
@Vad1mo
Copy link
Member Author

Vad1mo commented Aug 25, 2023

What do you @goharbor/all-maintainers think? Is it reasonable to have .github/ISSUE_TEMPLATE/bug_report.md and .github/ISSUE_TEMPLATE/issue.md at the same time?

IMO, I would stick with only issues:

@github-actions
Copy link

This PR is being marked stale due to a period of inactivty. If this PR is still relevant, please comment or remove the stale label. Otherwise, this PR will close in 30 days.

@github-actions github-actions bot added the Stale label Oct 24, 2023
@OrlinVasilev OrlinVasilev added never-stale Do not stale and removed Stale labels Oct 24, 2023
@OrlinVasilev
Copy link
Member

@Vad1mo will you remove the stackoverflow so we can merge this one :)

@Vad1mo Vad1mo enabled auto-merge (squash) January 17, 2024 12:12
Co-authored-by: Orlix <[email protected]>
Signed-off-by: Vadim Bauer <[email protected]>
- [ ] https://tenforward.consulting/blog/how-to-write-a-good-bug-report
-->

# Problem Descriptions
Copy link
Contributor

Choose a reason for hiding this comment

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

Doesn't this part overlaps the content in "bug_report", if user wants to report a problem he/she should follow "bug_report.md" right?

- [ ] https://github.com/search?q=org%3Agoharbor+YOUR-ISSUE&type=issues
- [ ] https://cloud-native.slack.com/archives/CC1E09J6S)
- [ ] https://goharbor.io/docs/latest/
- [ ] https://tenforward.consulting/blog/how-to-write-a-good-bug-report
Copy link
Contributor

Choose a reason for hiding this comment

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

This link is not relevant

Copy link
Contributor

@reasonerjt reasonerjt left a comment

Choose a reason for hiding this comment

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

The proposed change in the template has a lot overlap with "bug_report.md".

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
never-stale Do not stale release-note/infra Infra related changes e.g. release, test, ship etc...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants