link Pilot gdoc in our agents' Jira comments - #106
Merged
Conversation
Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the agent warning message in Jira comments to include a link to the Jotnar Pilot Google Doc. The change is functionally correct. I've added one suggestion to extract the hardcoded URL into a constant, which will improve the code's maintainability.
Comment on lines
+5
to
+9
| AGENT_WARNING = ( | ||
| "Warning: This is an AI-Generated contribution and may contain mistakes. " | ||
| "Please carefully review the contributions made by AI agents.\n" | ||
| "You can learn more about the Jotnar Pilot at https://docs.google.com/document/d/1mXTymiIe7MfjEDq6s4x0s3XnriC9db11DokdgZ5g9KU/edit" | ||
| ) |
Contributor
There was a problem hiding this comment.
For better maintainability and readability, it's a good practice to extract hardcoded URLs into their own constants. This makes it easier to find and update the URL in the future if it changes, without having to search through string definitions.
Suggested change
| AGENT_WARNING = ( | |
| "Warning: This is an AI-Generated contribution and may contain mistakes. " | |
| "Please carefully review the contributions made by AI agents.\n" | |
| "You can learn more about the Jotnar Pilot at https://docs.google.com/document/d/1mXTymiIe7MfjEDq6s4x0s3XnriC9db11DokdgZ5g9KU/edit" | |
| ) | |
| JOTNAR_PILOT_DOC_URL = "https://docs.google.com/document/d/1mXTymiIe7MfjEDq6s4x0s3XnriC9db11DokdgZ5g9KU/edit" | |
| AGENT_WARNING = ( | |
| "Warning: This is an AI-Generated contribution and may contain mistakes. " | |
| "Please carefully review the contributions made by AI agents.\n" | |
| f"You can learn more about the Jotnar Pilot at {JOTNAR_PILOT_DOC_URL}" | |
| ) |
Member
Author
There was a problem hiding this comment.
not worth the effort right now, sorry mate
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
yet another item from the checklist https://github.com/packit/jotnar/issues/123