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

[ReadMe] updated readMe file for QuoteBundleOptions-ReleaseNotification modules #33124

Conversation

vlmed
Copy link
Contributor

@vlmed vlmed commented Jun 2, 2021

Description (*)

Update README.md file for modules:

  • Magento_QuoteBundleOptions
  • Magento_QuoteConfigurableOptions
  • Magento_QuoteDownloadableLinks
  • Magento_QuoteGraphQl
  • Magento_RelatedProductGraphQl
  • Magento_ReleaseNotification

Fixed Issues (if relevant)

  1. magento/devdocs README content for modules - work in M2 Code devdocs#4451: README content for modules - work in M2 Code

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)

@m2-assistant
Copy link

m2-assistant bot commented Jun 2, 2021

Hi @vlmed. 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

❗ 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

ℹ️ 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.

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

🕙 You can find the schedule on the Magento Community Calendar page.

📞 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.

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

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

@vlmed
Copy link
Contributor Author

vlmed commented Jun 2, 2021

@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.

@gabrieldagama gabrieldagama added the Priority: P2 A defect with this priority could have functionality issues which are not to expectations. label Jun 3, 2021
@BarnyShergold
Copy link

@magento run Integration 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.

@BarnyShergold BarnyShergold self-assigned this Aug 27, 2021
@m2-community-project m2-community-project bot moved this from Pending Review to Review in Progress in High Priority Pull Requests Dashboard Aug 27, 2021
@BarnyShergold
Copy link

@magento run Functional Tests B2B, 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.

@BarnyShergold
Copy link

@magento run 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 re-request them if they don't show in a reasonable amount of time.

- `setPaymentMethodOnCart` mutation - defines which payment method to apply to the cart.
[Learn more about setPaymentMethodOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-payment-method.html).

- `setGuestEmailOnCart` mutation - assigns email to the quest cart.

Choose a reason for hiding this comment

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

Suggested change
- `setGuestEmailOnCart` mutation - assigns email to the quest cart.
- `setGuestEmailOnCart` mutation - assigns email to the guest cart.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

- `setGuestEmailOnCart` mutation - assigns email to the quest cart.
[Learn more about setGuestEmailOnCart mutation](https://devdocs.magento.com/guides/v2.4/graphql/mutations/set-guest-email.html).

- `setPaymentMethodAndPlaceOrder` mutation - sets the cart payment method and converts the cart into an order. This mutation has been deprecated. Use the `setPaymentMethodOnCart` and `placeOrder` mutations instead.

Choose a reason for hiding this comment

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

Make the fact this has been deprecated stand out.

Suggested change
- `setPaymentMethodAndPlaceOrder` mutation - sets the cart payment method and converts the cart into an order. This mutation has been deprecated. Use the `setPaymentMethodOnCart` and `placeOrder` mutations instead.
- `setPaymentMethodAndPlaceOrder` mutation - sets the cart payment method and converts the cart into an order. **This mutation has been deprecated**. Use the `setPaymentMethodOnCart` and `placeOrder` mutations instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done


## Extensibility

Extension developers can interact with the Magento_QuoteBundleOptions module. For more information about the Magento extension mechanism, see [Magento plug-ins](https://devdocs.magento.com/guides/v2.4/extension-dev-guide/plugins.html).

Choose a reason for hiding this comment

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

Question - on DevDocs & Knowledge Base use of "Magento" is being switched to "Adobe Commerce" - should we not be doing this on these new README.md now, rather than later?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we should leave a Magento as in the Readme template https://github.com/magento/devdocs/wiki/Magento-module-README.md provided by Magento.

Choose a reason for hiding this comment

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

Accepted!

@m2-community-project m2-community-project bot moved this from Review in Progress to Changes Requested in High Priority Pull Requests Dashboard Aug 31, 2021
@magento-engcom-team
Copy link
Contributor

Hi @BarnyShergold, thank you for the review.
ENGCOM-9211 has been created to process this Pull Request
✳️ @BarnyShergold, could you please add one of the following labels to the Pull Request?

Label Description
Auto-Tests: Covered All changes in Pull Request is covered by auto-tests
Auto-Tests: Not Covered Changes in Pull Request requires coverage by auto-tests
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests

@engcom-Hotel
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.

@BarnyShergold BarnyShergold added the Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests label Sep 6, 2021
@m2-community-project m2-community-project bot moved this from Testing in Progress to Ready for Testing in High Priority Pull Requests Dashboard Sep 6, 2021
@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-Hotel
Copy link
Contributor

@magento run 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 re-request them if they don't show in a reasonable amount of time.

@engcom-Hotel
Copy link
Contributor

✔️ QA Passed

The PR request has updates related to the README.md file content only.

No other manual testing is required and there is no impact on regression testing.

@m2-assistant
Copy link

m2-assistant bot commented Sep 23, 2021

Hi @vlmed, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@sidolov sidolov moved this from Merge in Progress to Recently Merged in High Priority Pull Requests Dashboard Sep 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Auto-Tests: Not Required Changes in Pull Request does not require coverage by auto-tests Component: QuoteBundleOptions Component: QuoteConfigurableOptions Component: QuoteDownloadableLinks Component: QuoteGraphQl Component: RelatedProductGraphQl Component: ReleaseNotification Partner: Atwix Pull Request is created by partner Atwix 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 Release Line: 2.4
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants