chore: add documentation around adding new dependencies#19427
chore: add documentation around adding new dependencies#19427mergify[bot] merged 6 commits intoaws:masterfrom corymhall:corymhall/docs-deps
Conversation
This adds a new section to the contributing guide that details how to introduce an "unconventional" dependency. It also adds a new section to the PR template that asks the submitter to verify whether their PR adds any dependencies.
|
|
kaizencc
left a comment
There was a problem hiding this comment.
I have to admit I still don't really get what an "unconventional" dependency is and how often it comes into play. Especially during community contributions -- does this amount warrant reminding all PR submissions to look out for it?
Is it possible to lint for this or add a workflow that runs on pull requests?
CONTRIBUTING.md
Outdated
| * Make sure to update the PR title/description if things change. The PR title/description are going to be used as the | ||
| commit title/message and will appear in the CHANGELOG, so maintain them all the way throughout the process. | ||
|
|
||
| #### Adding new dependencies |
There was a problem hiding this comment.
Is this section about adding (all) new dependencies or just "unconventional" ones?
There was a problem hiding this comment.
Just "unconventional" ones. Updated the title to reflect this.
yeah "unconventional" dependency is kind of ambiguous, but I think that is the point. It's hard to spell out because if we could then we would already have a way to handle it and wouldn't need to call it out. It really is just any dependency that you don't just I also think the PR checklist is for the contributor and for the reviewer. We should treat the PR checklist as things to look for as a reviewer
We might be able to add some checks, like if your PR is adding a |
kaizencc
left a comment
There was a problem hiding this comment.
I really like the idea of having a PR checklist for both contributor and reviewer, and we should continue to build this out with more helpful information (that can't be built into a PR check).
Co-authored-by: Kaizen Conroy <36202692+kaizen3031593@users.noreply.github.com>
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
This adds a new section to the contributing guide that details how to introduce an "unconventional" dependency. It also adds a new section to the PR template that asks the submitter to verify whether their PR adds any dependencies. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
This adds a new section to the contributing guide that details how to
introduce an "unconventional" dependency. It also adds a new section to
the PR template that asks the submitter to verify whether their PR adds
any dependencies.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license