Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

44 lines (34 loc) · 1.88 KB
Raw

CONTRIBUTING

You can fork this project within GitHub, as described on http://help.github.com. This fork will show up on your own github profile, and can be checked out to your local machine. After doing any changes in the project and committing in to your fork repository - make sure, you are up-to-date with upstream. After that, create a pull request (PR).

Some guidance for a successful pull request

  • Open PR for main branch only
  • Reference an issue in your PR, hence do not open a PR without a corresponding issue
  • Follow the single-purpose principle: Only one fix or feature in one PR
  • Write tests for newly introduced features or fixes
  • Apply a proper code style that fits to the existing one
  • Do not change the plugin metadata information (e.g. name, version, description, etc.) in src/main/resources/META-INF/plugin.xml

Some guidance for opening an issue

  • Follow the single-purpose principle: Only one issue per thread
  • For a bug reports:
    • Provide as many detailed information about your setup as possible
    • Point out the expected behavior in comparison with the current behavior
    • If possible, describe the steps on how to reproduce
  • For feature requests:
    • Search for duplicates/already existing feature request
    • Describe the wanted feature together with its use case and benefits
    • Provide examples if possible

Compiling the source code

Since the project has been migrated to the Gradle and Gradle IntelliJ plugin, the build process is quite simple. To build the plugin (including tests) just execute:

gradle build

All required dependencies like IntelliJ SDK, Grammar-Kit, etc are downloaded in the background and triggered properly during the build process. To start an IDE for manual testing, execute:

gradle runIdea

All of the gradle tasks can be connected to the IntelliJ debugger.