-
Notifications
You must be signed in to change notification settings - Fork 184
Add Citations and TL;DR #952
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
Conversation
198169c
to
c791dfe
Compare
docs/Security-Focused-Guide-for-AI-Code-Assistant-Instructions.md
Outdated
Show resolved
Hide resolved
docs/Security-Focused-Guide-for-AI-Code-Assistant-Instructions.md
Outdated
Show resolved
Hide resolved
Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Avishay Balter <[email protected]> Signed-off-by: balteravishay <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Avishay Balter <[email protected]> Signed-off-by: balteravishay <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Avishay Balter <[email protected]> Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
Co-authored-by: David A. Wheeler <[email protected]> Signed-off-by: Avishay Balter <[email protected]> Signed-off-by: balteravishay <[email protected]>
Co-authored-by: David A. Wheeler <[email protected]> Signed-off-by: Avishay Balter <[email protected]> Signed-off-by: balteravishay <[email protected]>
Co-authored-by: David A. Wheeler <[email protected]> Signed-off-by: Avishay Balter <[email protected]> Signed-off-by: balteravishay <[email protected]>
Co-authored-by: David A. Wheeler <[email protected]> Signed-off-by: Avishay Balter <[email protected]> Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
60a5845
to
d118e9b
Compare
Catherine Tony et al's work is especially appropriate to this work: https://arxiv.org/abs/2407.07064v2 The work found that RCI was the most effective, and if you couldn't do that, detailed prompting (as described here) was next-best. From a scientific view I understand why they compared approaches in isolation to each other. Yet from a practioner's view, I don't want to know "what one technique should I use". Nothing prevents us from using multiple techniques. I want to know "what combination of techniques would produce the best answers within various resource constraints"? The top two techniques were RCI (asking it to review its answer and correct it), followed by specific guidance on the results. Once my proposed addition of RCI is added to this text, we're incorporating both of the top 2 techniques. I hope there will continue to be experimentation. However, given the evidence I can currently find, that seems most likely to produce the best results. If someone finds a better way, we can update to match. |
Co-authored-by: David A. Wheeler <[email protected]> Signed-off-by: Avishay Balter <[email protected]>
Co-authored-by: David A. Wheeler <[email protected]> Signed-off-by: Avishay Balter <[email protected]>
Co-authored-by: David A. Wheeler <[email protected]> Signed-off-by: Avishay Balter <[email protected]>
Signed-off-by: balteravishay <[email protected]>
…hay/wg-best-practices-os-developers into avbalter/add-sections
Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
Co-authored-by: Copilot <[email protected]> Signed-off-by: Avishay Balter <[email protected]>
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.
Thanks so much! I contributed a lot of proposed tweaks which you've accepted. Copilot found a few formatting problems, which look legit. Could you please review them, and if they make sense, accept them?
Other than that, I think this new version is much better. Let's merge it & get WGs to review it. I think everyone will be delighted.
Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
I'm sorry that you had to suffer through an endless number of suggestions :-). But I'd like to think that the result now is lots better, and I didn't want to create merge conflicts. Please merge at your convenience. This is great stuff. |
Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
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.
Pull Request Overview
This PR adds comprehensive citations and a TL;DR section to the Security-Focused Guide for AI Code Assistant Instructions. It transforms the guide from a basic instructional document into a well-researched, academically-backed resource with proper attribution and quick reference material.
Key Changes
- Added a TL;DR section with essential security principles and sample instructions for immediate use
- Incorporated extensive citations throughout the document to support recommendations with research evidence
- Added a comprehensive appendix with detailed citations and references section
- Updated navigation links across documentation to reference the new guide
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
File | Description |
---|---|
docs/index.md | Added link to the Security-Focused Guide in the ongoing work examples |
docs/developers.md | Added the guide as a resource for developers with descriptive text |
docs/Security-Focused-Guide-for-AI-Code-Assistant-Instructions.md | Major expansion with TL;DR section, citations throughout, and references appendix |
Signed-off-by: balteravishay <[email protected]>
Signed-off-by: balteravishay <[email protected]>
Add Citations and TL;DR sections to Security-Focused Guide for AI Code Assistant Instructions