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

docs: Fix PR documentation to use GitHub Discussions, not Issues #7141

Merged
merged 3 commits into from
Jul 12, 2024
Merged

docs: Fix PR documentation to use GitHub Discussions, not Issues #7141

merged 3 commits into from
Jul 12, 2024

Conversation

pbaumard
Copy link
Contributor

Description

Fix PR documentation page since non-maintainers cannot use GitHub issues in trivy project.

Related issues

  • None (basic documentation issue).

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

Non-maintainers cannot use GitHub issues in trivy project.
@pbaumard pbaumard requested a review from knqyf263 as a code owner July 10, 2024 08:48
Copy link
Contributor

@itaysk itaysk left a 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?

@pbaumard
Copy link
Contributor Author

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.

@knqyf263 knqyf263 requested a review from itaysk July 11, 2024 05:56
@itaysk
Copy link
Contributor

itaysk commented Jul 11, 2024

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.

@itaysk
Copy link
Contributor

itaysk commented Jul 11, 2024

Is this clear enough?

Every Pull Request should have an associated GitHub Issue. Note that issues are created by Trivy mainatiners based on feedback provided in a GitHub Discussion. Please refer to the Issue and discussion pages for explanation about this process.
If you think your change is trivial enough, you can skip the issue and instead add justification and explanation in the PR description.

@knqyf263 knqyf263 added this pull request to the merge queue Jul 12, 2024
Merged via the queue into aquasecurity:main with commit 4308a0a Jul 12, 2024
7 checks passed
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.

3 participants