Skip to content

🕷️ The BEST Web Scraping framework that handles everything from a single request to a full-scale crawl! Don't be shy, join here: https://discord.gg/EMgGbDceNQ and follow here for daily tips and tricks: https://x.com/Scrapling_dev

docs: add an AI policy for contributions

Karim shoairb2106e60543f
diff --git a/AI_POLICY.md b/AI_POLICY.md
new file mode 100644
index 0000000..f4eade9
--- /dev/null
+++ b/AI_POLICY.md
@@ -0,0 +1,64 @@
+# AI Contribution Policy
+
+> [!IMPORTANT]
+>
+> If you are using **any kind of AI assistance** to contribute to Scrapling,
+> it must be disclosed in the pull request or issue.
+
+We welcome and encourage the use of AI tools to help improve Scrapling. Many valuable
+contributions have been enhanced with AI assistance for code generation, issue detection, and
+feature definition.
+
+That being said, if you are using any kind of AI assistance (e.g., agents such as Claude Code,
+ChatGPT) while contributing to Scrapling, **this must be disclosed in the pull request or
+issue**, along with the extent to which AI assistance was used (e.g., documentation comments
+vs. code generation).
+
+If your PR responses or comments are being generated by an AI, disclose that as well.
+
+As an exception, trivial spacing or typo fixes don't need to be disclosed, so long as the changes
+are limited to small parts of the code or short phrases.
+
+An example disclosure:
+
+> This PR was written primarily by Claude Code.
+
+Or a more detailed disclosure:
+
+> I consulted ChatGPT to understand the codebase but the solution
+> was fully authored manually by myself.
+
+Failure to disclose this is first and foremost rude to the human operators on the other end of the
+pull request, but it also makes it difficult to determine how much scrutiny to apply to the
+contribution.
+
+In a perfect world, AI assistance would produce equal or higher quality work than any human. That
+isn't the world we live in today, and in most cases where human supervision or expertise is not in
+the loop, it's generating code or changes that cannot be reasonably maintained or evolved.
+
+## What we're looking for
+
+When submitting AI-assisted contributions, please ensure they include:
+
+- **Clear disclosure of AI use** - You are transparent about AI use and the degree to which you're
+ using it for the contribution
+- **Human understanding** - You personally understand what the changes do
+- **Clear rationale** - You can explain why the change is needed and how it fits within Scrapling's
+ goals
+- **Concrete evidence** - Include test cases, scenarios, or examples that demonstrate the
+ improvement
+- **Your own analysis** - Share your thoughts on the end-to-end experience
+
+## What we'll close
+
+We reserve the right to close submissions that appear to not follow the disclosure policy.
+
+Issues and pull requests that appear to be undisclosed AI output are marked with the
+[`AI-Slop`](https://github.com/D4Vinci/Scrapling/issues?q=label%3A%22AI-Slop%22) label before
+being closed. Browse the label for examples of what not to submit.
+
+## Scope
+
+This policy applies to all contributions to the
+[Scrapling](https://github.com/D4Vinci/Scrapling) repository, including the library code, tests,
+documentation, translations, and the agent skill.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e1c7ac0..e896ab7 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -19,6 +19,7 @@ To ensure that your PR gets accepted, please make sure that your PR is based on
- **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.**
- **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.**
- **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.**
+- **Read our [AI Contribution Policy](AI_POLICY.md) before submitting. Any contribution made with AI assistance must disclose that in the PR or issue.**
- **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.**
- If you are adding a new feature, please add tests for it.
- If you are fixing a bug, please add code with the PR that reproduces the bug.