Closed
Description
This issue is automatically created based on existing pull request: #32610: Modified the PR template to include README.md update reqirement if necessary
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 (*)
- Attempt to create a Pull Request to this or any other github repository
- When on the PR edit page, copy-paste the modified template content into your PR description area
- Click Preview
- Along the Contribution checklist checkboxes you should see a new checkbox with a description saying that README.md needs to be modified if necessary
- Well, check if it looks beautiful :)
- 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)
Metadata
Metadata
Assignees
Labels
The issue has been fixed in 2.4-develop branchGate 3 Passed. Manual verification of the issue completed. Issue is confirmedA defect with this priority could have functionality issues which are not to expectations.The issue has been reproduced on latest 2.4-develop branchAffects aesthetics, professional look and feel, “quality” or “usability”.
Type
Projects
Status
Done