Move PR desc instructions from template to CONTRIBUTING.md #1134
+28
−22
Conversation
This file contains 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
Signed-off-by: Daniel Carl Jones <djonesoa@amazon.com>
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
dannycjones
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 of change
Until this change, we were using HTML comments in the PR template to provide instructions to contributors so they know what to include in a PR title and description. Since changing the default on GitHub to use the PR description as the squash commit message, we now see the HTML comments in comment messages which is not desired at all.
This change replaces HTML comments with non-comment TODOs which should be addressed and removed. These are visible to reviewers, who should prompt the author to address them before merging.
We move some of the more detailed instructions into
CONTRIBUTING.mdwhich is where we describe the contribution process more broadly.There's some minor simplification to the template given we can no longer provide clear instructions via HTML comment.
Does this change impact existing behavior?
This changes the default description for code contributions to the repository only.
No change to the file system or S3 client crates.
Does this change need a changelog entry in any of the crates?
No.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I agree to the terms of the Developer Certificate of Origin (DCO).