From 6b055ff7d61fffaf363141201d9ea0bfb330668b Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Fri, 26 Jun 2026 16:30:55 -0400 Subject: [PATCH 1/2] 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. --- .github/pull_request_template.md | 15 ++++++++++++ docs/contributing.md | 41 ++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..3ad524fba --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,15 @@ +#### Description + + +#### AI Assistance Disclosure + +- [ ] **No AI tools were used** in preparing this PR. +- [ ] **If AI tools were used**, I have disclosed which ones, and fully reviewed and verified their output. + +#### Checklist +- [ ] This PR follows the [contribution guidelines](https://python-markdown.github.io/contributing/). +- [ ] The code follows the [Code Style Guide](https://python-markdown.github.io/contributing/#code-style-guide). +- [ ] The commit message follows the [Commit Message Style Guide](https://python-markdown.github.io/contributing/#commit-message-style-guide). +- [ ] I have added or updated relevant docs, including release notes if applicable which follow the [Documentation Style Guide](Documentation Style Guide). +- [ ] I have added or updated relevant tests. +- [ ] I have not requested, and will not request, an automated AI review for this PR. diff --git a/docs/contributing.md b/docs/contributing.md index 7927847f0..011e3cb61 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -112,6 +112,46 @@ series of commits along with the discussion about those changes as they progress over time. If your pull request is accepted, it will be squashed at that time if deemed appropriate. +## AI Contributions + +Contributions to the Python-Markdown project are welcome, including those +developed with the assistance of generative AI tools. However, the use of +such tools does not change expectations for contributor responsibility, +engagement, or code quality. The following apply to all contributions. + +Contributors are responsible for all submitted content, regardless of whether +generative AI tools were used. + +Contributors must be able to explain all changes upon request during review. + +Contributors are responsible for ensuring all submitted code complies with +Python-Markdown's licensing, regardless of whether generative AI tools were +used. + +The pull request process should be collaborative and iterative. Contributors +are expected to actively engage with reviewer feedback themselves. +Contributors are expected to understand the changes they are proposing, not +act as a message courier for a third party. Copying and pasting replies to / +from a generative AI tool does not count as engaging with the reviewer. The +use of an AI agent to submit a pull request, issue, or comment autonomously +is not permitted. + +All code and prose (documentation, commit messages, comments, etc.) must +reflect the style and conventions used by the Python-Markdown project (see +[Code Style Guide](#code-style-guide), [Documentation Style +Guide](#documentation-style-guide), and [Commit Message Style +Guide](#commit-message-style-guide) below). + +Maintainers may close issues and pull requests that are not useful or +productive, regardless of whether AI tools were used or not. If a contributor +repeatedly opens unproductive issues or requests, they may be blocked from +contributing to the project as it is disruptive and disrespectful of the +maintainers' time. + +!!! Note + This policy was largely inspired by the Astropy Project's + [Usage of Generative AI] policy. + ## Style Guides In an effort to maintain consistency, Python-Markdown adheres to the following @@ -577,6 +617,7 @@ for details. [Babelmark]: https://johnmacfarlane.net/babelmark2/ [Creating a pull request from a fork]: https://help.github.com/articles/creating-a-pull-request-from-a-fork/ [action words]: https://help.github.com/articles/closing-issues-using-keywords/ +[Usage of Generative AI]: https://github.com/astropy/astropy-project/blob/b842b9bef3c8d69da73d639ea0254ae17fbc1fd1/policies/ai-policy.md [PEP8 Style Guide]: https://www.python.org/dev/peps/pep-0008/ [Flake8]: http://flake8.pycqa.org/en/latest/index.html [Markdown]: https://daringfireball.net/projects/markdown/basics From 7eaec855082e36e139eaf782567afe573b2a3a9f Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Fri, 26 Jun 2026 18:00:47 -0400 Subject: [PATCH 2/2] Update spelling dictionary --- .spell-dict | 1 + 1 file changed, 1 insertion(+) diff --git a/.spell-dict b/.spell-dict index 7e5171f54..dae754d0d 100644 --- a/.spell-dict +++ b/.spell-dict @@ -6,6 +6,7 @@ Altmayer API Artem aspell +Astropy Babelmark backtick backticks