Skip to content

Commit c698bc1

Browse files
Merge pull request #915 from doninAtwix/914-update-readme-file
914: Updated readme file with information about sandbox creation
2 parents 7d5570a + 751638f commit c698bc1

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,32 @@
6060
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.
6161
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.
6262

63+
## How to create SandBox for development
64+
1. Create sandbox folder
65+
2. Copy to sandbox folder `composer.json` and `composer.lock`
66+
3. In sandbox folder create `app/code` and `vendor/magento`
67+
4. Copy any of the magento modules (as for example: `framework`, `module-catalog`, `module-checkout`, `module-customer`, `module-sales`) into the `vendor/magento` folder. It is better to add as few modules as possible to reduce reindexing time during application running
68+
5. (Nice to have) Open IDE and go to `Preferences > Editor > File and Code Templates > Includes tab` and add default headers for `PHP File Header` and `XML File Header`
69+
70+
**PHP File Header:**
71+
```php
72+
/**
73+
* Copyright © Magento, Inc. All rights reserved.
74+
* See COPYING.txt for license details.
75+
*/
76+
declare(strict_types=1);
77+
```
78+
79+
**XML File Header:**
80+
```xml
81+
<!--
82+
/**
83+
* Copyright © Magento, Inc. All rights reserved.
84+
* See COPYING.txt for license details.
85+
*/
86+
-->
87+
```
88+
6389
### <img src="https://upload.wikimedia.org/wikipedia/commons/7/76/Slack_Icon.png" width="20"> Join the [#phpstorm-plugin](https://magentocommeng.slack.com/archives/C010C2LUCEA) Slack channel to get more involved
6490

6591
## License

0 commit comments

Comments
 (0)