Skip to content

add section to README to link to AI policy - #210

Open
matthugs wants to merge 3 commits into
twisted:trunkfrom
matthugs:matthugs/add-contributing-guidelines-for-ai-policy
Open

matthugs wants to merge 3 commits into
twisted:trunkfrom
matthugs:matthugs/add-contributing-guidelines-for-ai-policy

Conversation

@matthugs

Copy link
Copy Markdown

From discussion on the fediverse

@adiroiban

Copy link
Copy Markdown
Member

Just asking. Can we also create a pull request template? I think that is a good place to act as a reminder... and it's also a sign of LLM agents... which most of the time are ignoring the template... so it's a sign that the PR ls LLM generated.

@matthugs

Copy link
Copy Markdown
Author

Just asking. Can we also create a pull request template? I think that is a good place to act as a reminder... and it's also a sign of LLM agents... which most of the time are ignoring the template... so it's a sign that the PR ls LLM generated.

Excellent question and aligns with something Glyph said yesterday. (I'm doing this to a bunch of repos & have a spreadsheet going; reach out if you'd like to claim some repos to apply this treatment to with us.) Trying to get a good generic & basic list that will not need much editing across a large number of repos is slightly challenging; if you have ideas about that please share!

(copied wholesale from the Twisted main repository)
Please create one if missing.
Someone from the core team will probably do this for you, but your review might go a bit faster if you do it yourself.
* [ ] The title of the PR should describe the changes and starts with the associated issue number, like `#1234 Brief description`.
* [ ] A release notes news fragment file was create in src/incremental/newsfragments/ (see: [Release notes fragments docs.](https://docs.twisted.org/en/latest/development/dev-process.html))

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

highlighting this in the diff as the only line I tweaked from Twisted's PR template

@adiroiban adiroiban left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks. I think that this is much better than what we have now.
I will not merge this myself. I will leave for one of the active maintainers for incremntal to decide if this should be merged.

Thanks again!

@twm twm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for the PR! Before we can merge, could you address the issues I noted inline? Thanks!

* [ ] The title of the PR should describe the changes and starts with the associated issue number, like `#1234 Brief description`.
* [ ] A release notes news fragment file was create in src/incremental/newsfragments/ (see: [Release notes fragments docs.](https://docs.twisted.org/en/latest/development/dev-process.html))
* [ ] The automated tests were updated.
* [ ] Once all checks are green, request a review by leaving a comment that contains exactly the string `please review`.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This repo isn't set up with the review bot, so:

Suggested change
* [ ] Once all checks are green, request a review by leaving a comment that contains exactly the string `please review`.

Comment on lines +28 to +29
Our bot will trigger the review process, by applying the pending review label
and requesting a review from the Twisted dev team.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Same rationale:

Suggested change
Our bot will trigger the review process, by applying the pending review label
and requesting a review from the Twisted dev team.

Comment thread README.rst
Comment on lines +26 to +29
AI Policy
---------

This repository does not allow the inclusion of the outputs of generative AI tools, following the `Twisted AI Policy <https://docs.twisted.org/en/latest/development/ai-policy.html>`_.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Please move this to the end of the file, rather than interrupting the flow of the narrative documentation.

This branch has not been deployed

No deployments
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.

3 participants