Modified the PR template to include README.md update reqirement if necessary

[bgorski]

Description (*)

With the introduction of the README.md template, there is a requirement of describing module installation, structure and extension points in the readme.
We need to pay special attention to README.md always being up to date, because an outdated readme can do more harm than good. This is why all code contributors need to be aware that they are supposed to modify README.md as well when they create modifications that affect any of readme predefined sections.

Related Pull Requests

Fixed Issues (if relevant)

Manual testing scenarios (*)

1. Attempt to create a Pull Request to this or any other github repository
2. When on the PR edit page, copy-paste the modified template content into your PR description area
3. Click Preview
4. Along the Contribution checklist checkboxes you should see a new checkbox with a description saying that README.md needs to be modified if necessary
5. Well, check if it looks beautiful :)
6. Don't create that PR as you don't need to, unless you want to check that the markdown looks the same on an actual PR as in the Preview window

Questions or comments

Contribution checklist (*) - THIS SECTION CONTAINS THE CHECKBOX THAT I ADDED

• 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 README.md predefined sections require an update
• All automated tests passed successfully (all builds are green)

Resolved issues:

1. resolves [Issue] Modified the PR template to include README.md update reqirement if necessary #32658: Modified the PR template to include README.md update reqirement if necessary

[m2-assistant]

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

[bgorski]

@magento run all tests

[bgorski]

@magento run WebAPI Tests

[sidolov]

Hi @dobooth ! Could you please help us with the review? Thanks!

[magento-engcom-team]

Hi @sidolov, thank you for the review.
ENGCOM-8981 has been created to process this Pull Request

[engcom-Oscar]

@magento create issue

[engcom-Foxtrot]

@magento run all tests

[m2-assistant]

Hi @bgorski, 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.