Skip to content
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

Do not use AI tools to generate documentation #24258

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tdcmeehan
Copy link
Contributor

Description

Update contributing guide to call out AI tools. These generate low quality documentation and they are easily identifiable.

Motivation and Context

There have been a few examples of PRs which attempt to add documentation through the assistance of an AI tool. We should have more clear guidance that such documentation will not be merged by this project.

Impact

Avoid low quality documentation, alert developers that such PRs will not be merged.

Test Plan

N/A

Contributor checklist

  • Please make sure your submission complies with our contributing guide, in particular code style and commit standards.
  • PR description addresses the issue accurately and concisely. If the change is non-trivial, a GitHub Issue is referenced.
  • Documented new properties (with its default value), SQL syntax, functions, or other functionality.
  • If release notes are required, they follow the release notes guidelines.
  • Adequate tests were added if applicable.
  • CI passed.

Release Notes

== NO RELEASE NOTE ==

Update contributing guide to call out AI tools.  These generate low quality documentation and they are easily identifiable.
@tdcmeehan tdcmeehan requested review from steveburnett and a team as code owners December 13, 2024 15:05
@tdcmeehan tdcmeehan requested a review from presto-oss December 13, 2024 15:05
@prestodb-ci prestodb-ci added the from:IBM PR from IBM label Dec 13, 2024
@prestodb-ci prestodb-ci requested review from a team, Dilli-Babu-Godari and namya28 and removed request for a team December 13, 2024 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
from:IBM PR from IBM
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants