Contributing

Development Setup

This project is now Gradle based and is much easier to get the development environment setup to work on the plugin. You should only need to import the project in either Intellij Community or Intellij Ultimate and execute the runIde Gradle task. For more information please see the official Jetbrains plugin development documentation.

1. Download Intellij Idea CE or Ultimate
2. Open Intellij and select checkout from Version Control
3. Select import Gradle project from the unlinked gradle project dialog
4. Select the recommended settings and hit OK
5. Your project should be all set to coding
6. For more information see http://www.jetbrains.org/intellij/sdk/docs/tutorials/build_system/prerequisites.html

Raise issues before you start working

Before making any changes it may be worth your time to create an issue for the feature you'd like to add or your proposed modifications to an existing feature. This allows for feedback on a feature before you spend time working on something. Of course it's OK to create a pull request before doing this, but you may be surprised with some feedback on your feature. Any contribution is deeply appreciated and this approach is to help prevent would be contributors from being discourage by feedback after they have completed their work.

Current branching strategy

This master branch is the current stable release and new features and fixes are created on the development branch. If you are making pull requests consider basing your feature branch on the development branch instead of master. This is open for discussion if someone has a better approach for managing branches and commits.