-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
docs: Fix PR documentation to use GitHub Discussions, not Issues #7141
Conversation
Non-maintainers cannot use GitHub issues in trivy project.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, thanks for taking the time to fix this! I wanted to say that it's not incorrect that every PR needs to have an Issue. We still use Issues to track work items. The fix needs to clarify that users aren't expected to create issues directly but to start a discussion which will perhaps result in an issue. could you update your PR please?
I updated the PR. It seems hard to expect PR submitters to first wait for an issue. |
sorry for nitpicking but it makes it sound like discussions and issues are interchangable. If they were, we wouldn't have used both. For clarification (not needed in the dec), the discussion is just what it says - a conversation, and the Issue is a confirmed work item. A PR should have an Issue linked, unless it's a trivial change, this is aleady written. Allowing to linking a discussion in PR means there was already a discussion but it wasn't converted into an issue, so it's either not accepted, or too trivial for an Issue, in which case there's no need to link anything. Of course IRL people can link discussions or paste excepts or link to external resources in PRs, or anything that supports the PR description, but as far as the guidelines I would stick with link to Issue (ideally) or nothing. |
Is this clear enough?
|
Description
Fix PR documentation page since non-maintainers cannot use GitHub issues in trivy project.
Related issues
Checklist