magento2-phpstorm-plugin icon indicating copy to clipboard operation
magento2-phpstorm-plugin copied to clipboard

[Context-generation] Extend the README.md file generation

Open bohdan-harniuk opened this issue 2 years ago • 2 comments

Is your feature request related to a problem? Please describe.

We need to extend the README.md file generation through the context menu. For now it is raw and can be more useful.

Describe the solution you'd like (*)

  1. We need to check, if the README.md file is already generated we should not show action.
  2. We should add a new code include, to be able generate project-specific README.md files
Screenshot 2022-08-08 at 13 57 54 Screenshot 2022-08-08 at 13 55 34

Current content of the new code include will be:

<!---
    You can describe your module here.
    We recommend that you add the following information:
     - implementation details: why and how to use the module, preferably with some example scenarios
     - any dependencies (usually other modules but could be any important dependencies, libraries, etc)
     - extension points, APIs, plug-ins, etc
     - any introduced events
-->

Additional context

Mainline branch: 4.4.0-develop

bohdan-harniuk avatar Aug 08 '22 11:08 bohdan-harniuk

Hi @bohdan-harniuk. Thank you for your report. To speed up processing of this issue, make sure that you provided sufficient information.

Add a comment to assign the issue: @magento I am working on this


m2-assistant[bot] avatar Aug 08 '22 11:08 m2-assistant[bot]

@magento I am working on this

makzef avatar Aug 08 '22 11:08 makzef