Update Contributing guidelines, related documentation, and the PR template - #1104
Merged
Merged
Conversation
BrianJKoopman
added
documentation
Member
Author
|
Merging this. We discussed on the call last Friday, and no comments since. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR primarily focuses on updating the contributing guidelines to add our AI policies. It also includes some consistency changes in the README and installation docs, typo fixes, and updates to the PR template (which I use here in this PR).
Motivation and Context
SO recently published a policy on AI usage. #1092 was our first example of code submitted that was AI generated (as far as we know). Making these policies clear will help us label future PRs.
The PR template changes have been a long time coming. It was suggested a while back to make the checklist written to always be checked. I removed the 'types of changes' checkboxes in favor of encouraging those submitting PRs to label the PR appropriately, and merged two of the 'checklist' items into a single one. Now both of the items in the checklist should be checked always, otherwise the PR isn't 'done'.
How Has This Been Tested?
This has not been tested, but only contains changes to the documentation. The PR template is used in this PR.
Checklist:
AI Usage Disclosure
AI was not used in this PR.