Merge pull request #78 from magento/readme-update

Readme update

Author: Vitaliy

README.md

@@ -7,12 +7,12 @@
 This is a plugin for Magento 2 development in the PhpStorm IDE. It is available via the [JetBrains Plugin Repository](https://plugins.jetbrains.com/plugin/8024)
 ## Installation
 
-1. Go to Settings / Preferences in the PhpStorm IDE
-2. Navigate to "Plugins"
-3. Click the "Browse repositories..." button and search for "Magento PhpStorm"
+1. Go to `Settings > Preferences` in the PhpStorm IDE
+2. Navigate to `Plugins`
+3. Click the `Browse repositories...` button and search for "Magento PhpStorm"
 4. Install the plugin and restart PhpStorm
-5. Go to Settings / Preferences / Languages & Frameworks / PHP / Magento in the PhpStorm IDE
-6. Check "Enable" and "OK" button. 
+5. Go to `Settings > Preferences > Languages & Frameworks > PHP > Magento` in the PhpStorm IDE
+6. Check `Enable` and `OK` button.
 
 ## Works with
 * PhpStorm >= 2019.3.3
@@ -21,20 +21,38 @@ This is a plugin for Magento 2 development in the PhpStorm IDE. It is available
 ## Features
 
 * Configuration smart completion and references for XML/JavaScript files
-* "Navigate to configuration" reference in scope of class/interface
-* "Go to plugin" reference in scope of class/interface and method
-* "Navigate to Web API configuration" reference in scope of class/interface and method
+* `Navigate to configuration` reference in scope of class/interface
+* `Go to plugin` reference in scope of class/interface and method
+* `Navigate to Web API configuration` reference in scope of class/interface and method
 * Plugin class methods generation
 * Plugin declaration inspection
-* RequireJs reference navigation and completion
+* RequireJS reference navigation and completion
 * MFTF reference navigation and completion
 * GraphQL navigation line markers
 * Code generation
 * Inspections for XML configuration
 
+## Setting up development environment
+
+1. Check out this repository
+1. Open a folder with the project in the IntelliJ Ultimate using the `open` action button.
+1. Make sure that you on the latest develop branch (e.g `1.0.0-develop`)
+1. Right-click on the `build.gradle` file, choose "Import Gradle project"
+1. When the Gradle sections appeared in the right bar, navigate there and right-click `magento-2-php-storm-plguin > Tasks -> Intellij -> runIde`
+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.
+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.
+
+### <img src="https://upload.wikimedia.org/wikipedia/commons/7/76/Slack_Icon.png" width="20"> Join [#phpstorm-plugin](https://magentocommeng.slack.com/archives/C010C2LUCEA) Slack channel for more details.
+
+
 ## License
 Each Magento source file included in this distribution is licensed under OSL-3.0 license.
 
 Please see [LICENSE.txt](https://github.com/magento/magento2-phpstorm-plugin/blob/master/LICENSE.txt) for the full text of the [Open Software License v. 3.0 (OSL-3.0)](http://opensource.org/licenses/osl-3.0.php).
-
-### <img src="https://upload.wikimedia.org/wikipedia/commons/7/76/Slack_Icon.png" width="20"> Join [#phpstorm-plugin](https://magentocommeng.slack.com/archives/C010C2LUCEA) channel for more details.