Skip to content

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

Closed
@m2-assistant

Description

@m2-assistant

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 (*)

  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)

Metadata

Metadata

Assignees

Labels

Component: READMEFixed in 2.4.xThe issue has been fixed in 2.4-develop branchIssue: ConfirmedGate 3 Passed. Manual verification of the issue completed. Issue is confirmedPriority: P2A defect with this priority could have functionality issues which are not to expectations.Progress: doneReproduced on 2.4.xThe issue has been reproduced on latest 2.4-develop branchSeverity: S4Affects aesthetics, professional look and feel, “quality” or “usability”.

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions