Skip to content

Commit

Permalink
Do not use AI tools to generate documentation
Browse files Browse the repository at this point in the history
Update contributing guide to call out AI tools.  These generate low quality documentation and they are easily identifiable.
  • Loading branch information
tdcmeehan committed Jan 6, 2025
1 parent 87f4f39 commit 7913aa4
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -478,6 +478,7 @@ We use the [Fork and Pull model](https://docs.github.com/en/pull-requests/collab
* Ask reviewers to provide examples or code references without trying to find them on your own
* Protest lack of documentation for a code section
* Instead, review the related code, then draft initial documentation as a separate commit
* Use AI tools to generate documentation
* Submit without test cases or clear justification for lack thereof
* Request review when there are tests failing

Expand Down

0 comments on commit 7913aa4

Please sign in to comment.