Skip to content

Latest commit

 

History

History
70 lines (44 loc) · 3.76 KB

Contributing.md

File metadata and controls

70 lines (44 loc) · 3.76 KB
Raw

Contribution Guide

The project is build with Gradle and written in Java 8.

To start working on it simply clone and run ./gradlew build. See the section below on building and editing with Eclipse for step-by-step instructions.

ECA

In order to contribute code, you need to sign an Eclipse Contributor Agreement, using the e-mail used at Github. See https://eclipse.org/legal/ECA.php for details

GitHub Pull Requests

All GitHub Pull Requests run the following checks.

ip-validation

All Pull Requests must be by authors who have signed the ECA, and if they are not committers they must "Sign off" their commits. The "ip-validation" status check on GitHub will check this.

Jenkins PR Build

The Jenkins CI job builds and tests pull requests. All member of the GitHub Eclipse organisation should have their PRs built automatically as the whole organisation is on the whitelist. All other PRs need to be approved before they are built for the first time. To approve a PR you have to be an admin and say:

  • "run tests" to accept this pull request for testing
  • "test this please" for a one time test run
  • "add to whitelist" to add the author to the whitelist

If the build fails for other various reasons you can rebuild.

  • "retest this please" to start a new build

See full documentation for the GitHub Pull Request plug-in for Jenkins. To see the current list of Admins, visit the configuration -> Build Triggers -> GitHub Pull Request Builder -> Admin list. All LSP4J committers can add their GitHub username to that list.

The Pull Request Builder polls the GitHub repo at 5 minute intervals, so there may be a short delay before the check shows up as Pending on GitHub.

Eclipse

To develop with Eclipse this is the recommended flow:

  1. Using the latest Eclipse install a Java development environment that contains these features. These are all available in the "Install New Software" under the name of the release you are using (e.g. Oxygen)
  • JDT The Java Development Tools
  • The latest Buildship plugin (>= 2.*)
    • The LSP4J build is gradle based
  • Xtend IDE
    • Much of the code and tests are written in Xtend

  1. Fork/Clone the LSP4J repository

  2. Import the root of LSP4J as a Gradle project:

  • File -> Import
  • Existing Gradle Project
  • Select the root of the cloned directory as "Project root directory"
  • Finish the wizard - this will import all the projects but there will be lots of errors
  1. Run the "eclipse assemble" gradle targets.
  • There is already a launch configuration in the root of the repository called "lsp4j-build-gradle", run it.
  • Doing this will generate the missing files and update the project configurations
  1. Refresh the lsp4j projects.
  • This step is not needed if you have the "Refresh using native hooks or polling" setting (in Preferences -> General -> Workspace) enabled.
  1. Clean the projects
  • Project menu -> Clean...
  • Select all the lsp4j projects

Edit the .xtend files, not the files in xtend-gen directories. If you are in a Java file within the xtend-gen directory, right click and choose "Open Generated File".

The org.eclipse.lsp4j.generator project is used by the Xtend generator as an additional processor to contribute to the generated Java files. For example, the generator uses the @JsonRpcData annotation to convert the Xtend file and add things like equals, toString, hashCode.

Run the tests as you would run any normal JUnit tests (There is no need to run them as JUnit Plug-in Tests).