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.

Sign up for GitHub

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

Jump to bottom

Remove forbidden @author tag from Magento_Review #36977

Merged
merged 8 commits into from
Oct 5, 2023
Merged

Remove forbidden @author tag from Magento_Review #36977

merged 8 commits into from
Oct 5, 2023

Conversation

fredden
Copy link
Member

@fredden fredden commented Mar 6, 2023 •
edited by m2-assistant bot
Loading

Description

According to https://devdocs.magento.com/guides/v2.4/coding-standards/docblock-standard-general.html#documentation-space, the @author tag is not permitted in Magento. This pull request removes this tag from the Magento_Review module. Given there are so many instances of this tag, I've opened a small pull request to get the process started. I expect that the linter will force me to fix several other coding standards violations on the way, so having a smaller pull request means that task is easier to manage. I plan to open more pull requests to tackle the other instances of this tag.

See also magento/magento-coding-standard#382 and magento/magento-coding-standard#167

See also #36304, #36976

Manual testing scenarios

There are not code changes in this pull request. This pull request only removes forbidden 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)
  • 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)

Resolved issues:

  1. resolves [Issue] Remove forbidden @author tag from Magento_Review #37277: Remove forbidden @author tag from Magento_Review

@m2-assistant
Copy link

m2-assistant bot commented Mar 6, 2023

Hi @fredden. Thank you for your contribution!
Here are some useful tips on 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

❗ 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
ℹ️ Run only required test builds during development. Run all test builds before sending your pull request for review.

For more details, review the Code Contributions documentation.
Join Magento Community Engineering Slack and ask your questions in #github channel.

@m2-github-services m2-github-services added Partner: Fisheye partners-contribution Pull Request is created by Magento Partner labels Mar 6, 2023
@magento-automated-testing
Copy link

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.

This was referenced Mar 6, 2023
Merged
Open
Open
Merged
Merged
Open
Open
Open
Open
Open
Merged
Merged
Open
Open
@magento-automated-testing
Copy link

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-automated-testing
Copy link

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.

1 similar comment
@magento-automated-testing
Copy link

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.

leonhelmus
leonhelmus approved these changes Mar 20, 2023
View reviewed changes
Copy link

@leonhelmus leonhelmus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

app/code/Magento/Review/Model/ResourceModel/Rating/Collection.php
@@ -314,7 +311,9 @@ protected function _addStoreData()
if (is_array($data) && count($data) > 0) {
foreach ($data as $row) {
$item = $this->getItemById($row['rating_id']);
$item->setStores(array_merge($item->getStores(), [$row['store_id']]));
$stores = $item->getStores();
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fredden This seems Like a good change maybe add it in the desciption of the pull request.

@m2-assistant m2-assistant bot mentioned this pull request Mar 20, 2023
Closed
5 tasks
@engcom-Delta
Copy link
Contributor

@magento run all tests

@magento-automated-testing
Copy link

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.

@engcom-Delta
Copy link
Contributor

@magento run all tests

@magento-automated-testing
Copy link

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.

@engcom-Delta
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE,Functional Tests EE

@magento-automated-testing
Copy link

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.

@engcom-Delta
Copy link
Contributor

@magento run Functional Tests B2B, Functional Tests CE,Functional Tests EE

@magento-automated-testing
Copy link

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.

1 similar comment
@magento-automated-testing
Copy link

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.

@engcom-Delta
Copy link
Contributor

Unit Test failure is not related to the PR changes
Functional Tests B2B and CE failures are different on last two run
Functional B2B : run 1
Screenshot b2b 2023-03-27 at 10 47 26 AM
run 2
Screenshot 2023-03-27 at 3 03 24 PM
Functional CE : run 1
Screenshot 2023-03-27 at 3 05 26 PM
run 2
Screenshot 2023-03-27 at 7 09 50 PM

@engcom-Echo
Copy link
Contributor

@magento run all tests

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

@engcom-Echo
Copy link
Contributor

@magento run Integration Tests,Functional Tests CE,Functional Tests EE,Functional Tests B2B

@magento-automated-testing
Copy link

The requested builds are added to the queue. You should be able to see them here within a few minutes. Please message the #magento-devops slack channel if they don't show in a reasonable amount of time and a representative will look into any issues.

@engcom-Echo
Copy link
Contributor

Functional Tests EE,Functional Tests CE,Functional Tests B2B failures are different on last two run.
Functional Tests EE
Run1
36977-EE

Run2
36977-ee2

Functional Tests CE
Run1
36977-CE

Run2
36977-ee2

Functional Tests B2B
Run1
36977-B2B

Run2
36977-b2b2

Hence moving it to merge in progress

@magento-devops-reposync-svc magento-devops-reposync-svc merged commit 3ef65e4 into magento:2.4-develop Oct 5, 2023
9 of 12 checks passed
@fredden fredden deleted the no-author/review branch October 5, 2023 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leonhelmus leonhelmus leonhelmus approved these changes

Assignees

@leonhelmus leonhelmus

@engcom-Delta engcom-Delta

@engcom-Lima engcom-Lima

Labels
Partner: Fisheye partners-contribution Pull Request is created by Magento Partner Priority: P2 A defect with this priority could have functionality issues which are not to expectations. Progress: accept
Projects
Pull Requests Dashboard
Status: Recently Merged
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Issue] Remove forbidden @author tag from Magento_Review
7 participants
@fredden @engcom-Lima @engcom-Delta @engcom-Echo @leonhelmus @magento-devops-reposync-svc @m2-github-services