All contributions unless stated otherwise are assumed to be under project's license (Apache v2).

Whenever raising a pull request with your changes please remember to do the following things:

• Rebase pull request against master
• Add unit tests wherever possible
• Add functional tests wherever possible
• Ensure that regression tests are not broken
• Add information regarding your contribution to CONTRIBUTORS file
• Write clean code. It will be highly appreciated :)

XQuery - useful links

1. XQuery 3.0: An XML Query Language - W3C Candidate Recommendation
2. XQuery 3.0 Grammar
3. Building a Tokenizer for XPath or XQuery - Draft for XQuery 1.0
4. XML Query Use Cases
5. XML Query Use Cases - all in one file version
6. XQuery 3.0 compatiblity test suite
7. Guidelines for Running the QT3 Test Suite

Plugin development - useful links

1. Developing Custom Language Plugins for IntelliJ IDEA
2. Custom Language Support - Tutorial
3. Testing IntelliJ IDEA Plugins
4. Writing Tests for Plugins - Tutorial
5. IntelliJ IDEA Architectural Overview
6. Open API and Plugin Development - Developer Community Forum
7. Erlang support plugin for IntelliJ IDEA - source code on github
8. Developing a plugin for IntelliJ IDEA – some useful tips and links

Setup for development on Linux/Unix/Mac

• Fork intellij-xquery repository
• Fetch repository to your machine

git clone git@github.com:username/intellij-xquery.git

• Change directory to newly downloaded directory

cd intellij-xquery

• Download sdk

./gradlew downloadSdk

• Extract it

./gradlew unzipSdk

• Build the project

./gradlew build


• Generate IntelliJ Idea project structure

./gradlew idea


• Open project

• In File > Project Structure > Platform Settings > SDKs add IntelliJ Platform Plugin SDK (add JDK first if you haven't already)

• Select downloaded SDK (sdk sub directory of downloaded plugin sources), your own SDK if you prefer or downloaded source code repository of IntelliJ Community Edition pointing to the correct version tag

• In Project Settings > Project set newly created plugin SDK as Project SDK

• Check Plugin development useful links for more information on plugins required for plugin development

Setup for development on Windows

• Fork intellij-xquery repository
• Fetch repository to your machine

git clone git@github.com:username/intellij-xquery.git

• Change directory to newly downloaded directory

cd intellij-xquery

• Change the property in build.gradle file to point to your IntelliJ installation

project.ext.userDefinedInstallationPath = 'C:/opt/dev/ideaU'

• Build the project

gradlew build

• Generate IntelliJ Idea project structure

gradlew idea

• Open project
• In File > Project Structure > Platform Settings > SDKs add IntelliJ Platform Plugin SDK (add JDK first if you haven't already)
• Select the location of your IntelliJ Idea installation or downloaded source code repository of IntelliJ Community Edition pointing to the correct version tag
• In Project Settings > Project set newly created plugin SDK as Project SDK
• Check Plugin development useful links for more information on plugins required for plugin development