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.md which 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).
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).