-
Notifications
You must be signed in to change notification settings - Fork 4.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[proposal] Improvements to the AWS CLI Contribution Process #6828
Conversation
The proposal specifies improvements to the community contribution process for the AWS CLI.
Codecov Report
@@ Coverage Diff @@
## v2 #6828 +/- ##
===========================================
- Coverage 93.68% 62.69% -31.00%
===========================================
Files 350 350
Lines 35672 35679 +7
Branches 5105 5121 +16
===========================================
- Hits 33421 22369 -11052
- Misses 1646 12891 +11245
+ Partials 605 419 -186
Continue to review full report at Codecov.
|
@tim-finnigan asked me for feedback in #5425. Overall, this seems like a good approach, given the current situation. Here are some specific critiques:
|
Thank you for providing your feedback! I think you bring up some good points, but hopefully I can clarify.
There is intention behind the friction in the process, but I think some of it can be alleviated. We have to acknowledge that the AWS CLI is used extensively in production systems across the world, and thousands of users depend on it's stability. So, we need to move carefully and methodically to make sure we maintain that stability. The intention is to set up guard rails to make contributions successful. Additionally, I would not expect that a new user (or any user for that matter) should need to read our contributing guide from cover-to-cover to be successful. We're planning on writing a "Getting Started" guide that summarizes what is needed to contribute, and it will somewhat be up to us as maintainers to guide users through next steps. We've also planned regular retrospective meetings to evaluate the process and make adjustments - if we find that steps are onerous or unnecessary, we may trim them.
Good suggestion! We only specified a few types of changes that would not be taken and didn't enumerate all of the ones that would, but a cleanup might be one of those that would. A few thoughts on that:
We're considerate of that. We are currently using upvotes in some capacity now and haven't experienced that. We can also look at how much constructive commenting activity there is to supplement pile-on 👍🏻 or "+1" comments, but that's less automated at the moment.
I agree with you there! We're hoping the heavy lifting design discussions happen in the issue ahead of time, and the PR is focused on the implementation code. I think your suggested sentiment is captured in PR acceptance criteria listed here in the pre-review stage and the Review stage. Hope this answers your questions or concerns! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Just had one comment based on how we adjusted to using the new GitHub projects. Otherwise, feel free to add a new commit that moves the proposal to Accepted
similar to the source distribution proposal: 647b0e1
proposals/contribution-guide.md
Outdated
|
||
The contribution process will be implemented with a publicly visible [GitHub | ||
project Kanban | ||
board](https://docs.github.com/en/issues/organizing-your-work-with-project-boards). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we want to update the link here to the new GitHub projects feature we are using instead of the GitHub project board: https://docs.github.com/en/issues/trying-out-the-new-projects-experience/about-projects
The accepted state indicates that the initial proposal has been approved and official implementation is in-progress. As progress is made on the official implementation, amendments can be added to the accepted proposal.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! 🚢
@kdaily Could this be merged to the develop branch also, so it is easier to find when browsing the repo? Or at least a link from the CONTRIBUTING and README docs on the develop branch? |
The proposal specifies improvements to the community contribution process for the AWS CLI. For a Markdown rendered version of this proposal, view it here.
The AWS CLI development team is trying out a new process where proposals for new features are opened and reviewed as pull requests on GitHub. This allows us to be more open on our thought process and solicit design feedback from community members. Currently, we do not recommend community members from opening pull requests with new proposals until we have fully solidified and documented the proposal process. However, we do recommend and encourage community engagement by: