Skip to content

docs: add transparency about AI tool usage#96

Merged
GingerGraham merged 3 commits into
mainfrom
docs/updating-docs-march-2026
Mar 24, 2026
Merged

docs: add transparency about AI tool usage#96
GingerGraham merged 3 commits into
mainfrom
docs/updating-docs-march-2026

Conversation

@GingerGraham
Copy link
Copy Markdown
Owner

This pull request adds transparency about the maintainer's use of AI tools in the development workflow, updates the supported versions in the security policy, and clarifies responsibility for merged changes. The most important changes are:

Development Workflow Transparency:

  • Added a section to CONTRIBUTING.md explaining that the maintainer uses GitHub Copilot and Claude for development, review, and testing, but human review and approval are still required.
  • Added a similar note to README.md clarifying the maintainer's use of AI tools and that final responsibility for merged changes remains with the maintainer.

Security Policy Update:

  • Updated SECURITY.md to reflect that only versions 2.2.x and 2.3.x are currently supported for security updates; older versions are now marked as unsupported.

Copilot AI review requested due to automatic review settings March 24, 2026 10:39
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds documentation to increase transparency about the maintainer’s use of AI-assisted tools in the development workflow, and updates the security policy to reflect currently supported release lines.

Changes:

  • Update SECURITY.md to mark only 2.2.x and 2.3.x as supported for security updates.
  • Add “development workflow transparency” notes to README.md and CONTRIBUTING.md, clarifying AI tool usage and that responsibility remains with the maintainer.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
SECURITY.md Updates the supported-version matrix for security updates.
README.md Adds a maintainer transparency note about AI tool usage and responsibility.
CONTRIBUTING.md Adds contributor-facing transparency guidance about maintainer AI tool usage and human review requirements.

Comment thread README.md Outdated
Comment thread CONTRIBUTING.md Outdated
GingerGraham and others added 2 commits March 24, 2026 10:42
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Graham Watts <34165628+GingerGraham@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Graham Watts <34165628+GingerGraham@users.noreply.github.com>
@GingerGraham GingerGraham merged commit 5cfb1cd into main Mar 24, 2026
5 checks passed
@GingerGraham GingerGraham deleted the docs/updating-docs-march-2026 branch March 24, 2026 10:46
GingerGraham pushed a commit that referenced this pull request Apr 17, 2026
## [2.4.0](2.3.0...2.4.0) (2026-04-17)

### Documentation

* add transparency about AI tool usage ([#96](#96))

### Features

* add init_message option to suppress initialization log entry ([#99](#99))
@GingerGraham
Copy link
Copy Markdown
Owner Author

🎉 This PR is included in version 2.4.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants