-
Notifications
You must be signed in to change notification settings - Fork 144
docs(Contribute): add guidelines for contributing ai generated code #4680
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(Contribute): add guidelines for contributing ai generated code #4680
Conversation
There was a problem hiding this 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!
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this 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
- **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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- **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. |
packages/documentation-site/patternfly-docs/content/get-started/contribute.md
Outdated
Show resolved
Hide resolved
e44bcc4
to
57110d4
Compare
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
…d/contribute.md Co-authored-by: Erin Donehoo <[email protected]>
57110d4
to
46f36ae
Compare
Closes patternfly/pf-roadmap#255