Skip to content

link Pilot gdoc in our agents' Jira comments - #106

Merged
TomasTomecek merged 1 commit into
packit:mainfrom
TomasTomecek:link-pilot-doc
Aug 27, 2025
Merged

link Pilot gdoc in our agents' Jira comments#106
TomasTomecek merged 1 commit into
packit:mainfrom
TomasTomecek:link-pilot-doc

Conversation

@TomasTomecek

Copy link
Copy Markdown
Member

yet another item from the checklist https://github.com/packit/jotnar/issues/123

Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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 thread beeai/agents/constants.py
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"
)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

medium

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}"
)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

not worth the effort right now, sorry mate

@lbarcziova lbarcziova left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍

@TomasTomecek
TomasTomecek merged commit 24ca713 into packit:main Aug 27, 2025
1 check 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.

2 participants