Skip to content

Commit d38fd4a

Browse files
authored
Create AI Policy
The motivation for adopting this policy is to avoid wasting the maintainers' time. We work on this project as volunteers and it is an unproductive waste of time to interact with contributors who do not understand their contributions. While we generaly would prefer to receive contributions which are not AI generated, we understand that such tools can provide value in limited ways. Therefore, we have attempted to create a policy which allows use of such tools while also holding the contributor accountable. Hopefully this accomplishes our goal. Closes #1610.
1 parent ddead47 commit d38fd4a

3 files changed

Lines changed: 57 additions & 0 deletions

File tree

.github/pull_request_template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#### Description
2+
<!-- Provide a concise overview of the issue or rationale behind the proposed changes. -->
3+
4+
#### AI Assistance Disclosure
5+
<!-- Please select exactly ONE of the following: -->
6+
- [ ] **No AI tools were used** in preparing this PR.
7+
- [ ] **If AI tools were used**, I have disclosed which ones, and fully reviewed and verified their output.
8+
9+
#### Checklist
10+
- [ ] This PR follows the [contribution guidelines](https://python-markdown.github.io/contributing/).
11+
- [ ] The code follows the [Code Style Guide](https://python-markdown.github.io/contributing/#code-style-guide).
12+
- [ ] The commit message follows the [Commit Message Style Guide](https://python-markdown.github.io/contributing/#commit-message-style-guide).
13+
- [ ] I have added or updated relevant docs, including release notes if applicable which follow the [Documentation Style Guide](Documentation Style Guide).
14+
- [ ] I have added or updated relevant tests.
15+
- [ ] I have not requested, and will not request, an automated AI review for this PR. <!-- You are welcome to do so in your own fork. -->

.spell-dict

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Altmayer
66
API
77
Artem
88
aspell
9+
Astropy
910
Babelmark
1011
backtick
1112
backticks

docs/contributing.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,46 @@ series of commits along with the discussion about those changes as they
112112
progress over time. If your pull request is accepted, it will be squashed at
113113
that time if deemed appropriate.
114114

115+
## AI Contributions
116+
117+
Contributions to the Python-Markdown project are welcome, including those
118+
developed with the assistance of generative AI tools. However, the use of
119+
such tools does not change expectations for contributor responsibility,
120+
engagement, or code quality. The following apply to all contributions.
121+
122+
Contributors are responsible for all submitted content, regardless of whether
123+
generative AI tools were used.
124+
125+
Contributors must be able to explain all changes upon request during review.
126+
127+
Contributors are responsible for ensuring all submitted code complies with
128+
Python-Markdown's licensing, regardless of whether generative AI tools were
129+
used.
130+
131+
The pull request process should be collaborative and iterative. Contributors
132+
are expected to actively engage with reviewer feedback themselves.
133+
Contributors are expected to understand the changes they are proposing, not
134+
act as a message courier for a third party. Copying and pasting replies to /
135+
from a generative AI tool does not count as engaging with the reviewer. The
136+
use of an AI agent to submit a pull request, issue, or comment autonomously
137+
is not permitted.
138+
139+
All code and prose (documentation, commit messages, comments, etc.) must
140+
reflect the style and conventions used by the Python-Markdown project (see
141+
[Code Style Guide](#code-style-guide), [Documentation Style
142+
Guide](#documentation-style-guide), and [Commit Message Style
143+
Guide](#commit-message-style-guide) below).
144+
145+
Maintainers may close issues and pull requests that are not useful or
146+
productive, regardless of whether AI tools were used or not. If a contributor
147+
repeatedly opens unproductive issues or requests, they may be blocked from
148+
contributing to the project as it is disruptive and disrespectful of the
149+
maintainers' time.
150+
151+
!!! Note
152+
This policy was largely inspired by the Astropy Project's
153+
[Usage of Generative AI] policy.
154+
115155
## Style Guides
116156

117157
In an effort to maintain consistency, Python-Markdown adheres to the following
@@ -577,6 +617,7 @@ for details.
577617
[Babelmark]: https://johnmacfarlane.net/babelmark2/
578618
[Creating a pull request from a fork]: https://help.github.com/articles/creating-a-pull-request-from-a-fork/
579619
[action words]: https://help.github.com/articles/closing-issues-using-keywords/
620+
[Usage of Generative AI]: https://github.com/astropy/astropy-project/blob/b842b9bef3c8d69da73d639ea0254ae17fbc1fd1/policies/ai-policy.md
580621
[PEP8 Style Guide]: https://www.python.org/dev/peps/pep-0008/
581622
[Flake8]: http://flake8.pycqa.org/en/latest/index.html
582623
[Markdown]: https://daringfireball.net/projects/markdown/basics

0 commit comments

Comments
 (0)