Skip to content

Commit 4cbad30

Browse files
committed
Add contribution notes to the README
1 parent 2f81bde commit 4cbad30

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,26 @@ On PhpStorm or IntelliJ:
3232
* Inspection: Extbase `@inject` property injection + QuickFix
3333
* **Experimental:** Generate Fluid Styled Content Element (please report bugs!)
3434

35+
## Development and Contribution
36+
37+
Contributions are very welcome! :tada:
38+
39+
### Requirements
40+
41+
* IntelliJ IDEA works best when developing the plugin (Community Edition should be sufficient),
42+
but in theory, every Java IDE or even your text-editor should work
43+
44+
### QuickStart (*nix, please adjust to your platform)
45+
46+
* `git clone https://github.com/cedricziel/idea-php-typo3-plugin.git`
47+
* `cd idea-php-typo3-plugin`
48+
* `./gradlew runIde` - `gradlew.bat runIde` for Windows, this starts the IDE with the
49+
plugin configured and enabled
50+
* to begin development with IntelliJ, please import the `build.gradle` file as `new project from
51+
existing sources`
52+
* from IntelliJ run the Gradle task `runIde` (in debug mode), set break-points, profit!
53+
* ideally: send your pull request from a feature branch
54+
3555
## Credits
3656

3757
Thank you to <a href="https://github.com/Haehnchen">Daniel Espendiller</a> and <a href="https://github.com/adrienbrault">Adrien Brault</a>

0 commit comments

Comments
 (0)