Skip to content

Commit 147360d

Browse files
committed
revert AI guidelines until they can be approved
1 parent 891e781 commit 147360d

File tree

1 file changed

+0
-39
lines changed

1 file changed

+0
-39
lines changed

CONTRIBUTING.md

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -267,45 +267,6 @@ Please help in ensuring all relevant issues are closed and that any subsequent i
267267
- If an issue in Core will affect a component in PF-React, this issue should link to the main PF-React issue.
268268
- The CSS Developers and UX Designers should be tagged to review their respective PF-React issue.
269269

270-
### AI-Assisted Development Guidelines
271-
272-
AI-generated code can be accepted as a contribution to this project as long as the contributor follows the following guidance.
273-
274-
When using AI coding assistants (such as GitHub Copilot, ChatGPT, Claude, or other similar tools) to help with development work on PatternFly React, please follow these guidelines to ensure code quality, security, and transparency:
275-
276-
#### Human in the loop: Verify and validate AI-generated code
277-
278-
- **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.
279-
280-
- **Do not blindly 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.
281-
282-
- **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.
283-
284-
#### Mark code with substantial AI-generated portions
285-
286-
Nontrivial and substantial AI-generated or AI-assisted content should be "marked" in appropriate cases. In deciding how to approach this, consider adopting one or more of the following recommendations:
287-
288-
- **In a commit message, or in a pull request/merge request description field,** identify the code assistant that you used, perhaps elaborating on how it was used. You may wish to use a trailer like "Assisted-by:" or "Generated-by:". For example:
289-
290-
```
291-
Assisted-by: GitHub Copilot
292-
Generated-by: ChatGPT for initial component structure
293-
```
294-
295-
- **In a source file comment,** indicate the use of the code assistant. For example:
296-
297-
```javascript
298-
// Generated by GitHub Copilot
299-
// AI-assisted implementation with human review and modifications
300-
```
301-
302-
#### Additional considerations
303-
304-
- **Security review:** Pay special attention to security implications of AI-generated code, especially when dealing with user input, authentication, or data handling.
305-
- **Testing:** Ensure that AI-generated code is thoroughly tested and meets all existing project standards for testing coverage.
306-
- **Code style:** Verify that AI-generated code follows PatternFly React's coding standards and style guidelines as outlined in this document.
307-
- **Documentation:** If AI assists in generating documentation or comments, review them for accuracy and completeness.
308-
309270
## Troubleshooting
310271

311272
### Common Issues and Solutions

0 commit comments

Comments
 (0)