Repository navigation
docs: document the Code review comments setting - #83
Conversation
Co-Authored-By: rheza paleva <rhezapaleva24@gmail.com>
|
I'll fix CI failures and address comments from users with write access. I'll skip comments containing "(aside)".
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 68975f9d94
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
|
||
| Choose whether Hacktron posts scan results as comments on your pull requests and merge requests. This setting applies to every repository in your organization and is on by default. | ||
|
|
||
| To change it, go to **Settings → Code review comments**. Only organization admins can change this setting. |
There was a problem hiding this comment.
This says only organization admins can change the toggle, while the same page states that organization admins and owners can change organization settings. Owners therefore receive conflicting guidance about whether they can manage this new setting; clarify that owners are included, or document this as an explicit exception in the page introduction.
Useful? React with 👍 / 👎.
|
|
||
| - Scans still run as normal. | ||
| - Check statuses still update and can still block a merge. | ||
| - Findings remain available in Hacktron and connected tools such as Slack, Jira, and Linear. |
There was a problem hiding this comment.
When a finding has not been approved or sent and automatic ticket creation is disabled, merely connecting Jira or Linear does not make that finding available there: platform/project-management.mdx documents that only approved findings can be sent and that automatic tickets require auto-create. This bullet currently implies that every finding remains available in those tools when comments are disabled; qualify it to say that existing configured notification and ticket workflows continue unchanged.
Useful? React with 👍 / 👎.
rhezapaleva
left a comment
rhezapaleva
left a comment
There was a problem hiding this comment.
Reviewed the docs changes and verified they match the approved preview. Checks are green.
2 participants
Summary
Documents the org-level Post comments to source control toggle (Settings → Code review comments), which wasn't covered anywhere in the docs.
images/code_review_comments.png). It covers what the toggle does, that it's on by default and admin-only, what still happens when it's off (scans, check statuses and the merge gate, findings in Hacktron/Slack/Jira/Linear), and that turning it off doesn't remove existing comments.code-review/overview: "By default, Hacktron comments directly on affected code…"code-review/findings-feedback: "By default, Hacktron posts…", plus a link to the new sectioncode-review/config: the Fail-the-check intro, and the skip-comment line under Include scanscode-review/troubleshooting: "Developer is not covered" now says the check is skipped, and the no-seat comment is only posted when comments are onChecked locally: Prettier passes,
mintlify broken-linksfinds no broken links, and the pages render correctly inmintlify dev.Link to Devin session: https://app.devin.ai/sessions/91d71826f56442d2ba8361f806f5ee15
Open in Devin Desktop: https://app.devin.ai/desktop/session/91d71826f56442d2ba8361f806f5ee15?variant=devin
Requested by: @rhezapaleva