Skip to content

docs(Contribute): add guidelines for contributing ai generated code#4680

Merged
nicolethoen merged 16 commits into
patternfly:mainfrom
nicolethoen:ai_contribution_guidelines
Sep 3, 2025
Merged

docs(Contribute): add guidelines for contributing ai generated code#4680
nicolethoen merged 16 commits into
patternfly:mainfrom
nicolethoen:ai_contribution_guidelines

Conversation

@nicolethoen
Copy link
Copy Markdown
Collaborator

@nicolethoen nicolethoen commented Jun 30, 2025

@nicolethoen nicolethoen requested a review from edonehoo June 30, 2025 20:18
@patternfly-build
Copy link
Copy Markdown
Collaborator

patternfly-build commented Jun 30, 2025

Preview: https://pf-org--pr-4680-site.surge.sh

Copy link
Copy Markdown
Collaborator

@edonehoo edonehoo left a comment

Choose a reason for hiding this comment

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

Looks good! Mostly some formatting things. Just lmk if you have opinions/disagree with any!

Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
@nicolethoen nicolethoen requested a review from edonehoo July 3, 2025 14:30
Copy link
Copy Markdown
Collaborator

@edonehoo edonehoo left a comment

Choose a reason for hiding this comment

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

A few wonky tab formatting things in the lists

Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
Copy link
Copy Markdown
Collaborator

@edonehoo edonehoo left a comment

Choose a reason for hiding this comment

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

these guys are refusing to tab in. if this doesn't work, we'll just leave the spacing and manually set the list numbers if needed

Comment on lines +66 to +70
- **Treat AI-generated code as suggestions, not final code.** Review all generated code and modify as appropriate. Thoroughly review and test all code that you intend to integrate into your work.

- **Do not automatically trust the code assistant output.** Always apply your own judgment and expertise. AI coding assistants can introduce security vulnerabilities if not used carefully, and AI models can sometimes hallucinate and provide incorrect or non-functional code.

- **Make sure you thoroughly understand any AI-generated code.** If the generated code you intend to incorporate in your work is outside your expertise, consult with someone knowledgeable in the area prior to making it available to others within Red Hat or externally.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- **Treat AI-generated code as suggestions, not final code.** Review all generated code and modify as appropriate. Thoroughly review and test all code that you intend to integrate into your work.
- **Do not automatically trust the code assistant output.** Always apply your own judgment and expertise. AI coding assistants can introduce security vulnerabilities if not used carefully, and AI models can sometimes hallucinate and provide incorrect or non-functional code.
- **Make sure you thoroughly understand any AI-generated code.** If the generated code you intend to incorporate in your work is outside your expertise, consult with someone knowledgeable in the area prior to making it available to others within Red Hat or externally.
- **Treat AI-generated code as suggestions, not final code.** Review all generated code and modify as appropriate. Thoroughly review and test all code that you intend to integrate into your work.
- **Do not automatically trust the code assistant output.** Always apply your own judgment and expertise. AI coding assistants can introduce security vulnerabilities if not used carefully, and AI models can sometimes hallucinate and provide incorrect or non-functional code.
- **Make sure you thoroughly understand any AI-generated code.** If the generated code you intend to incorporate in your work is outside your expertise, consult with someone knowledgeable in the area prior to making it available to others within Red Hat or externally.

Comment thread packages/documentation-site/patternfly-docs/content/get-started/contribute.md Outdated
nicolethoen and others added 16 commits August 13, 2025 10:05
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
…d/contribute.md

Co-authored-by: Erin Donehoo <105813956+edonehoo@users.noreply.github.com>
@nicolethoen nicolethoen force-pushed the ai_contribution_guidelines branch from 57110d4 to 46f36ae Compare August 13, 2025 14:05
@nicolethoen nicolethoen requested a review from edonehoo August 18, 2025 20:53
@nicolethoen nicolethoen merged commit a5ecc2e into patternfly:main Sep 3, 2025
4 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.

Update AI generated code contribution guidelines in patternfly-org.

3 participants