Skip to content

Commit a0d1a37

Browse files
nzakassnitin315
andauthored
docs: Add AI Usage Policy (#20510)
* docs: Add AI Usage Policy * Update CONTRIBUTING.md * Remove extra content * Revert changes to code conventions * Update docs/src/contribute/ai-policy.md Co-authored-by: Nitin Kumar <snitin315@gmail.com> * Apply feedback * Update docs/src/contribute/ai-policy.md Co-authored-by: Nitin Kumar <snitin315@gmail.com> * Update policy --------- Co-authored-by: Nitin Kumar <snitin315@gmail.com>
1 parent bfce7ea commit a0d1a37

16 files changed

+60
-13
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ Please be sure to read the contribution guidelines before making or requesting a
66

77
This project adheres to the [OpenJS Foundation Code of Conduct](https://eslint.org/conduct). We kindly request that you read over our code of conduct before contributing.
88

9+
## AI Usage Policy
10+
11+
ESLint welcomes contributions from everyone, including those created with the assistance of Artificial Intelligence (AI) tools. We ask that you adhere to the [AI Usage Policy](https://eslint.org/docs/latest/contribute/ai-policy) when submitting contributions created with the assistance of AI tools.
12+
913
## Filing Issues
1014

1115
Before filing an issue, please be sure to read the guidelines for what you're reporting:

docs/src/contribute/ai-policy.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: AI Usage Policy
3+
eleventyNavigation:
4+
key: ai policy
5+
parent: contribute to eslint
6+
title: AI Usage Policy
7+
order: 1
8+
---
9+
10+
ESLint welcomes contributions from everyone, including those created with the assistance of Artificial Intelligence (AI) tools. We believe AI can be a powerful tool for improving software and want to encourage its responsible use in our project.
11+
12+
To ensure that AI contributions are integrated smoothly and maintain the quality of the codebase, we have established the following guidelines:
13+
14+
## Disclosure
15+
16+
If you use AI to generate an issue or a pull request, you must clearly disclose this in your submission. This helps maintainers understand the context of the contribution and perform appropriate reviews.
17+
18+
Issues and pull requests that do not disclose the use of AI may be closed without review. Those who violate this policy repeatedly may be blocked from contributing to ESLint.
19+
20+
## Human Responsibility
21+
22+
While AI can assist in generating code or text, the ultimate responsibility for the contribution remains with the human submitter.
23+
24+
- **Review your work:** Before submitting a pull request generated by AI, you are expected to have thoroughly reviewed and tested the code yourself. Ensure it meets ESLint's coding standards and correctly addresses the issue.
25+
- **Human responses:** When maintainers provide feedback or ask questions on your submission, we expect a human to respond. Please do not feed maintainer comments back into an AI to generate responses. We value human interaction and technical discussion.
26+
- **Edit for readability:** AI-generated content must be edited to make it easy for maintainers to review. This includes trimming unnecessary content, improving formatting, and ensuring that the contribution is clear and concise. PRs and issues that are difficult to review due to AI-generated content may be closed without review.
27+
28+
## Pull Request Acceptance Criteria
29+
30+
To help manage the volume of contributions, we have a specific policy for AI-generated pull requests:
31+
32+
- **Accepted Issues Only:** AI-generated PRs will only be considered for issues that have been officially marked as `accepted` by the ESLint team.
33+
- **Otherwise Closed:** AI-generated PRs submitted for issues that have not been marked as `accepted` will be closed without review.
34+
35+
We appreciate your cooperation in following these guidelines as we explore the benefits of AI-assisted development together!
36+
37+
## Compensation
38+
39+
ESLint does not provide compensation, either to team members or through the contributor pool, for contributions created primarily by AI. This is because we want to encourage human creativity and effort in our project, and we believe that AI should be used as a tool to assist rather than replace human contributions.

docs/src/contribute/architecture/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ eleventyNavigation:
44
key: architecture
55
parent: contribute to eslint
66
title: Architecture
7-
order: 5
7+
order: 6
88
---
99

1010
:::img-container

docs/src/contribute/core-rules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ eleventyNavigation:
44
key: contribute core rule
55
parent: contribute to eslint
66
title: Contribute to Core Rules
7-
order: 11
7+
order: 12
88
---
99

1010
The ESLint core rules are the rules included in the ESLint package.

docs/src/contribute/development-environment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ eleventyNavigation:
44
key: development environment
55
parent: contribute to eslint
66
title: Set up a Development Environment
7-
order: 6
7+
order: 7
88
---
99

1010
{%- from 'components/npm_tabs.macro.html' import npm_tabs with context %}

docs/src/contribute/governance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ eleventyNavigation:
44
key: governance
55
parent: contribute to eslint
66
title: Governance
7-
order: 12
7+
order: 13
88
---
99

1010
ESLint is an open source project that depends on contributions from the community. Anyone may contribute to the project at any time by submitting code, participating in discussions, making suggestions, or any other contribution they see fit. This document describes how various types of contributors work within the ESLint project.

docs/src/contribute/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@ This guide is intended for anyone who wants to contribute to an ESLint project.
1414

1515
ESLint welcomes contributions from everyone and adheres to the [OpenJS Foundation Code of Conduct](https://eslint.org/conduct). We kindly request that you read over our code of conduct before contributing.
1616

17+
## [AI Usage Policy](ai-policy)
18+
19+
We welcome AI-assisted contributions as long as they follow our guidelines for disclosure and human review.
20+
1721
## [Report Bugs](report-bugs)
1822

1923
Think you found a problem? We'd love to hear about it. This section explains how to submit a bug, the type of information we need to properly verify it, and the overall process.

docs/src/contribute/package-json-conventions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ eleventyNavigation:
44
key: package.json conventions
55
parent: contribute to eslint
66
title: Package.json Conventions
7-
order: 8
7+
order: 9
88
---
99

1010
The following applies to the "scripts" section of `package.json` files.

docs/src/contribute/propose-new-rule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ eleventyNavigation:
44
key: propose rule
55
parent: contribute to eslint
66
title: Propose a New Rule
7-
order: 2
7+
order: 3
88
---
99

1010
ESLint is all about rules. For most of the project's lifetime, we've had over 200 rules, and that list continues to grow. However, we can't just accept any proposed rule because all rules need to work cohesively together. As such, we have some guidelines around which rules can be part of the ESLint core and which are better off as custom rules and plugins.

docs/src/contribute/propose-rule-change.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ eleventyNavigation:
44
key: propose rule change
55
parent: contribute to eslint
66
title: Propose a Rule Change
7-
order: 3
7+
order: 4
88
---
99

1010
Occasionally, a core ESLint rule needs to be changed. This is not necessarily a bug, but rather, an enhancement that makes a rule more configurable. In those situations, we will consider making changes to rules.

0 commit comments

Comments
 (0)