Skip to content

Commit b2106e6

Browse files
committed
docs: add an AI policy for contributions
1 parent b498fe7 commit b2106e6

2 files changed

Lines changed: 65 additions & 0 deletions

File tree

AI_POLICY.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# AI Contribution Policy
2+
3+
> [!IMPORTANT]
4+
>
5+
> If you are using **any kind of AI assistance** to contribute to Scrapling,
6+
> it must be disclosed in the pull request or issue.
7+
8+
We welcome and encourage the use of AI tools to help improve Scrapling. Many valuable
9+
contributions have been enhanced with AI assistance for code generation, issue detection, and
10+
feature definition.
11+
12+
That being said, if you are using any kind of AI assistance (e.g., agents such as Claude Code,
13+
ChatGPT) while contributing to Scrapling, **this must be disclosed in the pull request or
14+
issue**, along with the extent to which AI assistance was used (e.g., documentation comments
15+
vs. code generation).
16+
17+
If your PR responses or comments are being generated by an AI, disclose that as well.
18+
19+
As an exception, trivial spacing or typo fixes don't need to be disclosed, so long as the changes
20+
are limited to small parts of the code or short phrases.
21+
22+
An example disclosure:
23+
24+
> This PR was written primarily by Claude Code.
25+
26+
Or a more detailed disclosure:
27+
28+
> I consulted ChatGPT to understand the codebase but the solution
29+
> was fully authored manually by myself.
30+
31+
Failure to disclose this is first and foremost rude to the human operators on the other end of the
32+
pull request, but it also makes it difficult to determine how much scrutiny to apply to the
33+
contribution.
34+
35+
In a perfect world, AI assistance would produce equal or higher quality work than any human. That
36+
isn't the world we live in today, and in most cases where human supervision or expertise is not in
37+
the loop, it's generating code or changes that cannot be reasonably maintained or evolved.
38+
39+
## What we're looking for
40+
41+
When submitting AI-assisted contributions, please ensure they include:
42+
43+
- **Clear disclosure of AI use** - You are transparent about AI use and the degree to which you're
44+
using it for the contribution
45+
- **Human understanding** - You personally understand what the changes do
46+
- **Clear rationale** - You can explain why the change is needed and how it fits within Scrapling's
47+
goals
48+
- **Concrete evidence** - Include test cases, scenarios, or examples that demonstrate the
49+
improvement
50+
- **Your own analysis** - Share your thoughts on the end-to-end experience
51+
52+
## What we'll close
53+
54+
We reserve the right to close submissions that appear to not follow the disclosure policy.
55+
56+
Issues and pull requests that appear to be undisclosed AI output are marked with the
57+
[`AI-Slop`](https://github.com/D4Vinci/Scrapling/issues?q=label%3A%22AI-Slop%22) label before
58+
being closed. Browse the label for examples of what not to submit.
59+
60+
## Scope
61+
62+
This policy applies to all contributions to the
63+
[Scrapling](https://github.com/D4Vinci/Scrapling) repository, including the library code, tests,
64+
documentation, translations, and the agent skill.

CONTRIBUTING.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ To ensure that your PR gets accepted, please make sure that your PR is based on
1919
- **The PR must be made against the [**dev**](https://github.com/D4Vinci/Scrapling/tree/dev) branch of Scrapling. Any PR made against the main branch will be rejected.**
2020
- **The code should be passing all available tests. We use tox with GitHub's CI to run the current tests on all supported Python versions for every code-related commit.**
2121
- **The code should be passing all code quality checks like `mypy` and `pyright`. We are using GitHub's CI to enforce code style checks as well.**
22+
- **Read our [AI Contribution Policy](AI_POLICY.md) before submitting. Any contribution made with AI assistance must disclose that in the PR or issue.**
2223
- **Make your changes, keep the code clean with an explanation of any part that might be vague, and remember to create a separate virtual environment for this project.**
2324
- If you are adding a new feature, please add tests for it.
2425
- If you are fixing a bug, please add code with the PR that reproduces the bug.

0 commit comments

Comments
 (0)