From 538b1cf9af12190c07c473ea490857a90c99613e Mon Sep 17 00:00:00 2001 From: vitaliy Date: Fri, 14 Feb 2025 21:33:40 +0200 Subject: [PATCH] Add contribution and support links to README.md Updated the contribution guide with corrected backlog links and expanded resources for learning to contribute. Added a "Buy Me a Coffee" badge to encourage community support. --- README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d93376c45..0de1c8732 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,7 @@ This is a PhpStorm IDE plugin for a better Magento 2 development workflow. [![Version](http://phpstorm.espend.de/badge/8024/version)](https://plugins.jetbrains.com/plugin/8024) [![Downloads](http://phpstorm.espend.de/badge/8024/downloads)](https://plugins.jetbrains.com/plugin/8024) [![Made With Love](https://img.shields.io/badge/Made%20With-Love-orange.svg)](https://magento.com) +[![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Support-orange.svg)](https://buymeacoffee.com/vitalii_b) ## Installation @@ -55,13 +56,18 @@ This is a PhpStorm IDE plugin for a better Magento 2 development workflow. 1. Click `Run "magento-2-php-storm-plugin"` to run the plugin. You should see a new instance of IntelliJ launched with the plugin installed. Make sure the plugin is enabled in IntelliJ settings and indexing is finished. Plugin features should be accessible at this point. ## How to contribute -1) Start with looking into [Community Backlog](https://github.com/magento/magento2-phpstorm-plugin/projects/2). Any ticket in `Ready for Development` and `Good First Issue` columns are a good candidates to start. +1) Start with looking into [Community Backlog](https://github.com/magento/magento2-phpstorm-plugin/issues?q=is%3Apr+is%3Aopen+label%3A%22good+first+issue). Any ticket in `Ready for Development` and `Good First Issue` columns are a good candidates to start. 2) Didn't satisfy your requirements? [Create a new issue](https://github.com/magento/magento2-phpstorm-plugin/issues/new). It can be for example: - **Bug report** - Found a bug in the code? Let us know! - **Enhancement** - Know how to improve existing functionality? Open an issue describe how to enhance the plugin. - **New feature proposal** - Know how to make a killer feature? Do not hesitate to submit your proposal. -3) The issue will appear in the `Ready for Grooming` column of the [Community Backlog](https://github.com/magento/magento2-phpstorm-plugin/projects/2). Once it will be discussed and approved the issue will be ready for development. -4) Refer to the [Contributing Guide](https://github.com/magento/magento2-phpstorm-plugin/blob/2.1.0-develop/.github/CONTRIBUTING.md) for more information on how to contribute. +3) The issue will appear in the `Ready for Grooming` column of the [Community Backlog](https://github.com/magento/magento2-phpstorm-plugin/issues?q=is%3Apr+is%3Aopen+label%3A%22good+first+issue). Once it will be discussed and approved the issue will be ready for development. +4) Refer to the [Contributing Guide](https://github.com/magento/magento2-phpstorm-plugin/blob/5.4.0-develop/.github/CONTRIBUTING.md) for more information on how to contribute. + +## Learn to contribute +1) SDK [Developing a Plugin](https://plugins.jetbrains.com/docs/intellij/developing-plugins.html) +2) Good Presentation about platform [How We Built Comma, the Raku IDE, on the IntelliJ Platform](https://www.youtube.com/watch?v=zDP9uUMYrvs) +3) Plugin example [idea-php-symfony2-plugin](https://github.com/Haehnchen/idea-php-symfony2-plugin) ## How to create SandBox for development 1. Create sandbox folder