magento / catalog-storefront

Open Software License 3.0
7 stars 18 forks source link

Modified the PR template to include README.md update reqirement if ne… #477

Open bgorski opened 3 years ago

bgorski commented 3 years ago

…cessary

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)

  1. Fixes magento/catalog-storefront#

Questions or comments

Code Review Checklist (*)

See detailed checklist