mirror of
https://github.com/open-quantum-safe/liboqs.git
synced 2025-10-04 00:02:01 -04:00
Add guidance / questions on generative AI use (#2269)
* Add guidance / questions on generative AI use Addresses https://github.com/orgs/open-quantum-safe/discussions/2253 Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca> * Suggestions from Basil Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca> * Fix typo [skip ci] Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca> * Wording suggestions from Norm [skip ci] Co-authored-by: Norman Ashley <nashley@cisco.com> Signed-off-by: Douglas Stebila <dstebila@users.noreply.github.com> * Add link to OpenSSF AI guidelines. [skip ci] Suggested by @AdityaKoranga in https://github.com/orgs/open-quantum-safe/discussions/2253#discussioncomment-14427125 Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca> --------- Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca> Signed-off-by: Douglas Stebila <dstebila@users.noreply.github.com> Co-authored-by: Norman Ashley <nashley@cisco.com>
This commit is contained in:
Douglas Stebila
GitHub
parent
1ae1b92302
commit
9b0b72d225
34
.github/ISSUE_TEMPLATE/bug_report.md
vendored
34
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,34 +0,0 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**To Reproduce**
|
||||
Steps to reproduce the behavior:
|
||||
1. Go to '...'
|
||||
2. Click on '....'
|
||||
3. Scroll down to '....'
|
||||
4. See error
|
||||
|
||||
**Expected behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain your problem.
|
||||
|
||||
**Environment (please complete the following information):**
|
||||
- OS: [e.g. Ubuntu 20]
|
||||
- OpenSSL version [e.g., 3.0.2]
|
||||
- Compiler version used [e.g., clang 9.0.0]
|
||||
- Build variables used [e.g., "-DOQS_ALGS_ENABLED=STD"]
|
||||
- liboqs version [e.g. 0.7.2 or main branch]
|
||||
|
||||
**Additional context**
|
||||
Add any other context about the problem here.
|
||||
56
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
56
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@ -0,0 +1,56 @@
|
||||
# This template was generated with [Issue Forms Creator](https://issue-forms-creator.netlify.app)
|
||||
name: Bug report
|
||||
description: Template for bug reports
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: >-
|
||||
Thank you for submitting a bug report to liboqs. Before submitting, we
|
||||
encourage you to search through the following resources:
|
||||
|
||||
- [issues](https://github.com/open-quantum-safe/liboqs/issues)
|
||||
|
||||
- [pull requests](https://github.com/open-quantum-safe/liboqs/pulls)
|
||||
|
||||
|
||||
If this is a question regarding usage rather than a bug in the software,
|
||||
the best place for that is our Github [discussion
|
||||
forum](https://github.com/orgs/open-quantum-safe/discussions).
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: A clear and concise description of what the bug is.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected behaviour
|
||||
description: What did you expect to happen?
|
||||
- type: input
|
||||
attributes:
|
||||
label: liboqs version
|
||||
description: Which version of liboqs are you using?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Please describe the environment in which you are running liboqs
|
||||
value: |-
|
||||
- Architecture: [e.g., x86_64]
|
||||
- OS: [e.g. Ubuntu 24.04 LTS]
|
||||
- OpenSSL version [e.g., 3.0.2]
|
||||
- Compiler version used [e.g., clang 9.0.0]
|
||||
- Build variables used [e.g., "-DOQS_ALGS_ENABLED=STD"]
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Use of generative AI
|
||||
description: >-
|
||||
If this contribution (code, documentation, descriptive text) was
|
||||
produced with the help of generative AI, please describe the nature of
|
||||
the use. Contributors are expected to have verified and affirm such contributions
|
||||
themselves before submission.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional information
|
||||
description: Add any other context about the problem here.
|
||||
29
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
29
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@ -0,0 +1,29 @@
|
||||
# This template was generated with [Issue Forms Creator](https://issue-forms-creator.netlify.app)
|
||||
name: Feature request
|
||||
description: 'Suggest a new feature '
|
||||
body:
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Description
|
||||
description: A clear and concise description of the problem or missing capability
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe the solution you'd like
|
||||
description: If you have a solution in mind, please describe it.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Describe alternatives you've considered
|
||||
description: Have you considered any alternative solutions or workarounds?
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Are you willing to help develop the solution?
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Use of generative AI
|
||||
description: >-
|
||||
If this contribution (code, documentation, descriptive text) was
|
||||
produced with the help of generative AI, please describe the nature of
|
||||
the use. Contributors are expected to have verified and affirm such contributions
|
||||
themselves before submission.
|
||||
2
.github/pull_request_template.md
vendored
2
.github/pull_request_template.md
vendored
@ -9,5 +9,7 @@
|
||||
* [ ] Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from *x.y.z* to *x.(y+1).0*.)
|
||||
* [ ] Does this PR change the list of algorithms available -- either adding, removing, or renaming? Does this PR otherwise change an API? (If so, PRs in fully supported downstream projects dependent on these, i.e., [oqs-provider](https://github.com/open-quantum-safe/oqs-provider) will also need to be ready for review and merge by the time this is merged.)
|
||||
|
||||
<!-- If this contribution (code, documentation, descriptive text) was produced with the help of generative AI, please describe the nature of the use. Contributors are expected to have verified and affirm such contributions themselves before submission. -->
|
||||
|
||||
<!-- Once your pull request is ready for review and passing continuous integration tests, please convert from a draft PR to a normal PR, and request a review from one of the OQS core team members. -->
|
||||
|
||||
|
||||
@ -25,6 +25,9 @@ particularly in case of possible bugs or new feature requests or create a
|
||||
Pull requests should clearly state their purpose, possibly referencing an existing
|
||||
[issue](https://github.com/open-quantum-safe/liboqs/issues) when resolving it.
|
||||
|
||||
Pull requests containing code, documentation, or text produced with the help of generative AI must declare that in the pull request description and describe the nature of the use. Contributors are expected to have verified and affirm such contributions themselves before submission.
|
||||
Contributors using AI assistants are encouraged to read the OpenSSF's [Security-Focused Guide for AI Code Assistant Instructions](https://best.openssf.org/Security-Focused-Guide-for-AI-Code-Assistant-Instructions).
|
||||
|
||||
All PRs should move to "Ready for Review" stage only if all CI tests pass (are green).
|
||||
|
||||
The OQS core team is happy to provide feedback also to Draft PRs in order to improve
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user