Skip to content
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

[Issue] Include Constructor to be a part of CommandListInterface API, extend inline documentation #31102

Open
4 tasks
m2-assistant bot opened this issue Nov 30, 2020 · 2 comments · May be fixed by #37901
Open
4 tasks
Assignees
Labels
Component: Console feature request Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: PR in progress Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Milestone

Comments

@m2-assistant
Copy link

m2-assistant bot commented Nov 30, 2020

This issue is automatically created based on existing pull request: #29762: Include Constructor to be a part of CommandListInterface API, extend inline documentation


Description (*)

In my personal opinion using CommandListInterface is invalid way of adding new Commands to interface.
It is because Constructor is not a part of Interface (Service Contract), thus it is not "guaranteed" part of Interface.

Using CommandList is against Magento rules, thus it's implementation is not guaranteed and can change in backwards-incompatible way.

I'm extending the CommandList with @api to ensure developers that this class won't change backwards-incompatible way and this way - they can either add new classes using:

  • Argument injection to CommandList class
  • Plugin on getCommands on CommandListInterface.

I'd love to get your feedback there.

After discussion with @kandy I decided to add the __construct() to the API.

Answering the main concerns: https://3v4l.org/8ug8i
image

As it affects you (community) I need your 👍🏻 or comments to pass the change:
image

Related Pull Requests

Fixed Issues (if relevant)

  1. Fixes magento/magento2#<issue_number>

Manual testing scenarios (*)

  1. ...
  2. ...

Questions or comments

Contribution checklist (*)

  • Pull request has a meaningful description of its purpose
  • All commits are accompanied by meaningful commit messages
  • All new or changed code is covered with unit/integration tests (if applicable)
  • All automated tests passed successfully (all builds are green)

Thanks

@m2-assistant m2-assistant bot added Component: Console Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. labels Nov 30, 2020
@m2-community-project m2-community-project bot added this to Pull Request In Progress in High Priority Backlog Nov 30, 2020
@gabrieldagama gabrieldagama added this to the 2.5 milestone Jan 25, 2021
@m2-community-project m2-community-project bot added this to Pull Request In Progress in 2.5 Milestone Backlog Jan 25, 2021
@m2-community-project m2-community-project bot removed this from Pull Request In Progress in High Priority Backlog Jan 25, 2021
@engcom-November engcom-November added the Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it label Sep 20, 2022
@m2-community-project m2-community-project bot added this to Pull Request In Progress in High Priority Backlog Sep 20, 2022
@m2-community-project m2-community-project bot removed this from Pull Request In Progress in 2.5 Milestone Backlog Sep 20, 2022
@engcom-Hotel engcom-Hotel self-assigned this Nov 18, 2022
@m2-assistant
Copy link
Author

m2-assistant bot commented Nov 18, 2022

Hi @engcom-Hotel. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

  • 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

    DetailsIf the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

  • 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

  • 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

  • 4. Verify that the issue is reproducible on 2.4-develop branch

    Details- Add the comment @magento give me 2.4-develop instance to deploy test instance on Magento infrastructure.
    - If the issue is reproducible on 2.4-develop branch, please, add the label Reproduced on 2.4.x.
    - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

  • 5. Add label Issue: Confirmed once verification is complete.

  • 6. Make sure that automatic system confirms that report has been added to the backlog.

@engcom-Hotel
Copy link
Contributor

Hello @lbajsarowicz,

We are marking this as a feature request for moving it further.

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Console feature request Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: PR in progress Severity: S4 Affects aesthetics, professional look and feel, “quality” or “usability”. Triage: Dev.Experience Issue related to Developer Experience and needs help with Triage to Confirm or Reject it
Projects
Feature Requests Backlog
  
Pull Request in Progress
5 participants