chore: add AI_POLICY and update Pull request template

This commit is contained in:
Christian Visintin
2026-08-30 21:47:28 +02:00
parent 974b6d6917
commit 7472ca98a0
2 changed files with 72 additions and 34 deletions
+9 -34
View File
@@ -1,40 +1,15 @@
# ISSUE _NUMBER_ - PULL_REQUEST_TITLE
# Description
Fixes # (issue)
## Description
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
List here your changes
- I made this...
- I made also that...
## Type of change
Please select relevant options.
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update
<!--
Provide a brief description of the changes you made in this pull request. If your changes are related to a specific issue, please mention the issue number (e.g., "Fixes #123").
-->
## Checklist
- [ ] My code follows the contribution guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] My changes generate no new warnings
- [ ] I formatted the code with `cargo fmt`
- [ ] I checked my code using `cargo clippy` and reports no warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] I have introduced no new _C-bindings_
- [ ] The changes I've made are Windows, MacOS, UNIX, Linux compatible (or I've handled them using `cfg target_os`)
- [ ] I increased or maintained the code coverage for the project, compared to the previous commit
- [ ] I have read the [AI Policy](https://github.com/veeso/termscp/blob/main/AI_POLICY.md) and the [contributing guidelines](https://github.com/veeso/termscp/blob/main/CONTRIBUTING.md).
## Acceptance tests
## AI Disclosure
wait for a _project maintainer_ to fulfill this section...
- [ ] regression test: ...
<!--
Describe how you used AI tools in this contribution. If you did not use any AI tools, write "N/A".
-->
+63
View File
@@ -0,0 +1,63 @@
# AI Policy
The maintainers of this project don't want to interact directly with bots.
Contributions must come from a human who understands the submitted code or text,
can explain it, and is responsible for its quality as if they wrote it
themselves. Using AI as a tool to help you write or reason about a contribution
is fine; submitting AI output you don't understand, or relaying messages
between a maintainer and an AI, is not.
If you wish to include context from an interaction with AI in your comments, it
must be in a quote block (e.g., using `>`) and disclosed as such. It must be
accompanied by human commentary explaining the relevance and implications of
the context.
If you plan to contribute to termscp using AI tools, you **must** read,
understand and follow this policy.
## Disclosure
You **must** disclose the use of AI tools in your contributions. You
**must** perform this disclosure through the pull request template; filing
PRs without using the pull request template is a violation of this policy.
This applies to any AI tool that generated or substantially shaped the content
you submit — code, prose or commit messages — including agents, chat assistants
and AI-assisted editors. Mechanical editor autocompletion of a few characters
does not need to be disclosed; if in doubt, disclose.
## Translations
AI is useful when communicating as a non-native English speaker. If you are
using AI to edit your comments for this purpose, please take the time to ensure
it reflects your own voice and ideas.
## Provenance and licensing
You are responsible for the provenance of anything you submit. AI tools can
reproduce code or text from their training data verbatim, which may carry a
license incompatible with this project. By contributing, you confirm the work
is yours to submit under the project's license and does not infringe a third
party's rights. The same standard that applies to code you write by hand.
## Consequences
Violating this policy may get your contribution rejected and, for repeated or
egregious violations, get you blocked from the project without further warning.
## Examples
Examples of things that are not allowed:
- Point an agent to a GitHub issue, ask it to solve the issue and open a PR,
without understanding the issue, the PR, or testing the solution yourself.
- Copy responses from the AI when replying to questions from maintainers,
without understanding the question or the response.
In other words, you should not "play telephone" between your AI-generated code,
the reviewer, and the AI tool.
## Inspiration
This AI policy was inspired by:
- [release-plz](https://github.com/release-plz/.github/blob/main/AI_POLICY.md)