-
Notifications
You must be signed in to change notification settings - Fork 7
Add DEEP framework AI usage guidance to issue and PR templates #46
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
Open
rtibbles
wants to merge
2
commits into
main
Choose a base branch
from
add-deep-framework-to-templates
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,6 +12,8 @@ Instructions: | |
| * Use the 'preview' function above this text box to verify formatting before submitting | ||
| --> | ||
|
|
||
| **Target branch:** <!-- e.g. develop, release-0.17.x --> | ||
|
|
||
| ## Observed behavior | ||
| <!-- | ||
| Description of the behavior that was observed, including screenshots or other references when applicable | ||
|
|
@@ -67,6 +69,29 @@ Tell us about your environment, including: | |
| … | ||
|
|
||
| <!-- | ||
| AI DISCLOSURE: If this issue was written with AI assistance, add: | ||
| 🤖 This issue was written with AI assistance, under supervision, review and final edits by [@username] 🤖 | ||
| OPTIONAL - Delete if not needed. | ||
|
|
||
| AI USAGE - DEEP guidelines | ||
|
|
||
| If AI was used in preparing this issue, please fill in the section below. | ||
| Our DEEP guidelines ask that when using AI you: | ||
|
|
||
| Disclose - Be open about when you've used AI for support. | ||
| Engage critically - Question what is generated. Verify claims and sources. | ||
| Edit - Digest and refine AI output rather than copy-pasting it. | ||
| Process sharing - Explain how you used the AI so others can learn. | ||
|
|
||
| Examples of good disclosures: | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nice! |
||
|
|
||
| "I used Gemini to help draft this issue from my rough notes. I edited | ||
| the description for accuracy, confirmed the reproduction steps myself, | ||
| and trimmed the verbose output." | ||
|
|
||
| "This is based on a Claude summary of clearinghouse feedback. I | ||
| cross-checked the key points against the original feedback and rewrote | ||
| the requirements in my own words." | ||
|
|
||
| If AI was not used, delete the section below. | ||
| --> | ||
|
|
||
| ## AI usage | ||
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
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
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
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
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
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
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
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.
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.
In majority of cases it'll probably be needed. And if there's an expectation for people to pay attention, whether us or external contributors, I would probably just delete this line..Because optional = skip automatically for many :)
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.
And to allow for some exceptions, we could keep the previous phrasing?