Skip to content

Add automated tools guidelines for AI-assisted contributions#10181

Open
AndrewAsseily wants to merge 1 commit intoaws:gh-pagesfrom
AndrewAsseily:gh-pages-automated-tools
Open

Add automated tools guidelines for AI-assisted contributions#10181
AndrewAsseily wants to merge 1 commit intoaws:gh-pagesfrom
AndrewAsseily:gh-pages-automated-tools

Conversation

@AndrewAsseily
Copy link
Copy Markdown
Contributor

Description of changes:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@bri-tong
Copy link
Copy Markdown

bri-tong commented Apr 1, 2026

Code Review — PR #10181

Summary

This is a small, clean documentation-only PR that adds a new automated_tools.md page to the gh-pages contributor guide, establishing guidelines for AI-assisted contributions. It also updates index.md to register the new page in the toctree and topic list. The change is well-scoped and the content is reasonable. This appears to be the gh-pages companion to #10176 (targeting develop) and #10178 (targeting v2) by the same contributor.


Blocking Issues

None.


Non-blocking Suggestions

  1. Duplication / DRY concern across branches: The content of automated_tools.md is nearly identical to what PR chore: add additional text to CONTRIBUTING.md #10176 adds to CONTRIBUTING.md on develop. If the gh-pages site is auto-generated from develop, this PR may be overwritten or cause conflicts once chore: add additional text to CONTRIBUTING.md #10176 merges. If gh-pages is independently maintained, the duplication is fine — but worth a note in the PR description to clarify the intent.

  2. Toctree placement: automated_tools is placed between testing and support in the toctree. This is a reasonable spot, though another natural location could be right after contribution_process since the automated tools policy is fundamentally a contribution guideline. Minor either way.

  3. Escaped angle brackets (\<person\> in automated_tools.md line 10): Verify this renders as intended with the specific static site generator used for gh-pages (e.g., Sphinx with MyST). Some renderers may treat \< differently.


Questions / Clarifications

  1. Is gh-pages manually maintained or auto-built? If this branch is auto-generated (e.g., from a Sphinx/docs build in CI), this PR would be overwritten on the next build cycle. The PR description should clarify this.

  2. Relationship to referenced PRs: The description links to add additional text to CONTRIBUTING.rst #10178 and chore: add additional text to CONTRIBUTING.md #10176 but doesn't explain the relationship. It would be helpful to state explicitly that this is the gh-pages port of the same policy — especially since maintainers reviewing all three PRs need to understand the coordination.

  3. Self-compliance: The PR adds guidelines requiring AI-sourced submissions to include a statement like "generated by AI tools, and reviewed by <person>". If this content was AI-assisted, it should follow its own rules.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants