chore: add additional text to CONTRIBUTING.rst#3662
Conversation
There was a problem hiding this comment.
LGTM
Notes for our team:
We should consider either including this as a page on our public botocore docs sites or convert these files to .md so GitHub can render them. This thought came up since CODE_OF_CONDUCT.md doesn't actually link to anything right now. If we put them on our docs site, they need to remain as .rst.
|
FWIW, many projects are aligning on AI_POLICY.md for presenting this kind of information. |
|
Interesting, I hadn't noticed this trend. It seems like this blog post was the origin of the
|
|
Yeah, it should go in the .github directory with all your other informational files. Hopefully GitHub will eventually link to it like it does the others. It's definitely not "standard" but there's usage is a sizable portion of bigger projects. |
SamRemis
left a comment
SamRemis
left a comment
There was a problem hiding this comment.
Thanks for the PR, Tom.
Prior to merging, I'd like to get your input on two comments I've added here as well as what your opinion on moving this to AI_POLICY.md as suggested by Nate above
| AI must first be reviewed by a human before submitting to the repository. | ||
| Items reviewed in this way must include a statement like "generated by AI | ||
| tools, and reviewed by <person>" | ||
| - Please ensure that your submissions are actually improvements. While we are |
There was a problem hiding this comment.
[Requested change, open to discussion]
While I'm fully supportive of this statement, it's no limited to AI.
We have seen similar hand-written floods of PRs for things like advent of code. @kellertk , would you be open to two things here moving this bullet point out of the automated tools section since it's more widely applicable?
There was a problem hiding this comment.
The section I added presumes that your team already has policies/practices that are broadly applicable to low-quality PRs. The section about automated tooling is actually intended to supplement that. I think the Please ensure that your submissions are actually improvements statement is broadly applicable and could easily be applied elsewhere in the document - it probably doesn't matter so much as long at it appears somewhere.
On the other hand, keeping everybody's Automated Tooling sections precisely the same makes updating all of them easier in the future. But as long as we're aligned across the AWS SDKs on the intent, minor changes like this are fine.
| in this repository, but due to the volume of submissions we ask that you observe | ||
| the following rules: | ||
|
|
||
| - All issue and pull request submissions to this repository that are sourced by |
There was a problem hiding this comment.
[Requested change, open to discussion]
I'd like to see this be more strict. @kellertk, would you consider updating this policy to apply to all GitHub interactions (comments on issues/PRs, discussions, etc.), as opposed to scoping it to just "issue and pull request submissions".
I think that was your intention here, but the wording leaves this open to interpretation.
There was a problem hiding this comment.
No, but only because the top of your document says.
This document contains guidelines for contributing code and filing issues.
If your CONTRIBUTING.rst has some rewrites so that is a general contribution guide, I agree that would be appropriate.
* release-1.42.88: Bumping version to 1.42.88 Update to latest models chore: add additional text to CONTRIBUTING.rst (#3662)
4 participants
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.