docs: add guidelines for responsible use of AI tools 📝#178
Open
mingcheng wants to merge 1 commit into
Open
Conversation
- document AI tool usage policy in GOVERNANCE.md with disclosure requirements - add AI tools section to CONTRIBUTING.md with best practices - emphasize human review and accountability for AI-assisted contributions - maintain quality standards regardless of AI involvement Signed-off-by: mingcheng <mingcheng@apache.org>
mingcheng
added
community
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds project-level guidance for responsible use of AI tools in Dragonfly community contributions, aiming to increase transparency (disclosure), ensure human accountability, and keep quality standards consistent for AI-assisted work.
Changes:
- Add an “Use of AI Tools” policy section to
GOVERNANCE.md, including disclosure and quality/accountability expectations. - Add an “Use of AI Tools” section (and TOC entry) to
CONTRIBUTING.mdwith practical guidance for AI-assisted PRs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| GOVERNANCE.md | Introduces governance-level policy and expectations for AI tool usage, disclosure, and maintainers’ enforcement options. |
| CONTRIBUTING.md | Adds contributor-facing AI tool guidance and disclosure instructions in the PR submission workflow. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+168
to
+172
| Dragonfly welcomes responsible use of AI tools when they help contributors work more effectively. If you use an AI tool while preparing a contribution, please make sure its purpose and scope are clear. For example, AI tools may help draft documentation, suggest code changes, summarize logs, or improve wording, but they should not replace your own understanding of the change. | ||
|
|
||
| When submitting an AI-assisted PR, please mention it in the PR description. Include the tool you used and a short explanation of what it helped with. This helps reviewers understand the context of the work and keeps the review process transparent. | ||
|
|
||
| Before submitting, carefully review and edit any AI-generated content. Your PR must still meet Dragonfly's quality standards, including correctness, tests where appropriate, clear documentation, and compatibility with the rest of the project. Contributors remain responsible for the accuracy and quality of everything they submit. |
Comment on lines
+30
to
+34
| ## Use of AI Tools | ||
|
|
||
| We do not oppose the use of AI tools in community work. Used responsibly, they can help contributors explore ideas, improve documentation, and speed up routine tasks. However, AI tools should support human judgment, not replace it. Community members are expected to use AI tools with a clear purpose and scope, and to make sure their work still reflects careful review and accountability. | ||
|
|
||
| When AI tools are used to create or modify contributions, contributors must disclose that use in the related issue, pull request, or other community discussion. The disclosure should name the tool and briefly explain how it was used, such as drafting text, suggesting code, summarizing logs, or reviewing language. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Related Issue
#176