magento2 icon indicating copy to clipboard operation
magento2 copied to clipboard

Improving the code readability by importing the classes

Open tiagosampaio opened this issue 3 years ago • 20 comments

Description (*)

Improving the code readability by importing the classes.

Related Pull Requests

Fixed Issues (if relevant)

  1. No issue is fixed with this PR.

Manual testing scenarios (*)

Questions or comments

Contribution checklist (*)

  • [x] Pull request has a meaningful description of its purpose
  • [x] All commits are accompanied by meaningful commit messages
  • [x] All new or changed code is covered with unit/integration tests (if applicable)
  • [x] README.md files for modified modules are updated and included in the pull request if any README.md predefined sections require an update
  • [ ] All automated tests passed successfully (all builds are green)

tiagosampaio avatar Jun 07 '21 18:06 tiagosampaio

Hi @tiagosampaio. Thank you for your contribution Here are some useful tips how you can test your changes using Magento test environment. Add the comment under your pull request to deploy test or vanilla Magento instance:

  • @magento give me test instance - deploy test instance based on PR changes
  • @magento give me 2.4-develop instance - deploy vanilla Magento instance

:exclamation: Automated tests can be triggered manually with an appropriate comment:

  • @magento run all tests - run or re-run all required tests against the PR changes
  • @magento run <test-build(s)> - run or re-run specific test build(s) For example: @magento run Unit Tests

<test-build(s)> is a comma-separated list of build names. Allowed build names are:

  1. Database Compare
  2. Functional Tests CE
  3. Functional Tests EE,
  4. Functional Tests B2B
  5. Integration Tests
  6. Magento Health Index
  7. Sample Data Tests CE
  8. Sample Data Tests EE
  9. Sample Data Tests B2B
  10. Static Tests
  11. Unit Tests
  12. WebAPI Tests
  13. Semantic Version Checker

You can find more information about the builds here

:information_source: Please run only needed test builds instead of all when developing. Please run all test builds before sending your PR for review.

For more details, please, review the Magento Contributor Guide documentation.

:warning: According to the Magento Contribution requirements, all Pull Requests must go through the Community Contributions Triage process. Community Contributions Triage is a public meeting.

:clock10: You can find the schedule on the Magento Community Calendar page.

:telephone_receiver: The triage of Pull Requests happens in the queue order. If you want to speed up the delivery of your contribution, please join the Community Contributions Triage session to discuss the appropriate ticket.

:movie_camera: You can find the recording of the previous Community Contributions Triage on the Magento Youtube Channel

:pencil2: Feel free to post questions/proposals/feedback related to the Community Contributions Triage process to the corresponding Slack Channel

m2-assistant[bot] avatar Jun 07 '21 18:06 m2-assistant[bot]

@magento run all tests

tiagosampaio avatar Jun 10 '21 13:06 tiagosampaio

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

@magento run all

tiagosampaio avatar Jul 16 '21 15:07 tiagosampaio

Failed to run the builds. Please try to re-run them later.

@magento run all tests

tiagosampaio avatar Jul 16 '21 15:07 tiagosampaio

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please re-request them if they don't show in a reasonable amount of time.

Pull Requests are not mergeable to the mainline. Please merge the latest mainlines to your Pull Requests and restart the builds.

@tiagosampaio , Please resolve the conflict on the PR to move ahead on this.

engcom-Delta avatar Jan 05 '24 15:01 engcom-Delta

@magento run all tests

engcom-November avatar Jul 01 '24 10:07 engcom-November

@magento run all tests

engcom-November avatar Jul 02 '24 06:07 engcom-November

As this PR is to improve code quality, manual testing is not required.

Since the builds are failing, moving this to Extended Testing.

engcom-November avatar Jul 03 '24 05:07 engcom-November

@magento run Functional Tests B2B

engcom-November avatar Jul 03 '24 11:07 engcom-November

Honestly, I find that this doesn't improve readability at all, like when you see ManagerInterface, what does it mean?

I think proper aliases should be used if the claim is to improve readability, for example:

use Magento\Framework\Event\ManagerInterface as EventManagerInterface;

And next to ManagerInterface, I think that these ones are too generic and also could use a proper alias:

  • Element
  • Field
  • Group
  • Loader
  • Structure

(I maybe have missed some, naming things is hard, I know)

hostep avatar Jul 03 '24 12:07 hostep

Thank you @hostep for the input.

I have made the changes as you suggested. Moving this to Pending review, to make sure everything is good before moving further with the pr.

engcom-November avatar Jul 05 '24 07:07 engcom-November