Skip to content

Latest commit

 

History

History
166 lines (145 loc) · 8.49 KB

Contributing.md

File metadata and controls

166 lines (145 loc) · 8.49 KB
Raw

TEE Contributor Guide

This instructions below will help you get your development environment setup so that you can contribute to this repository.

Ways to Contribute

Interested in contributing to the team-explorer-everywhere project? There are plenty of ways you can contribute, all of which help make the project better.

Build and Run with Eclipse

Tools

Install Eclipse Mars.2 Release (4.5.2) for RCP and RAP Developers or later.

Java Requirements

We use JavaSE-1.6 as the minimal supported Java execution environment. Depending on the Eclipse version you use you might have to install a later JDK version.

For Eclipse Mars install JDK 8 or later. You can find the JDK downloads on Oracle's web site at Java SE Downloads. Find older versions in Previous Releases.

Eclipse IDE Configuration

In a new empty Eclipse workspace open the Preferences dialog using Window -> Preferences menu option.

  1. Set JRE preferences
  • Go to the Java -> Installed JREs page.
    • Click the Add button.
    • Select Standard VM and click the Next button.
    • Enter a full JDK path into the JRE home field. Note that you should use the JDK folder, not a JRE one.
    • Click the Finish button.
    • Select the check-box at the added JDK and click the Apply button.
  • Go to the Java -> Installed JREs -> Execution Environment page.
    • Select JavaSE-1.6 in the Execution Environments column.
    • Select the check-box at the desired compatible JDK in the Compatible JREs column.
  1. Set Compiler preferences
  • Go to the Java -> Compiler page.
    • Select 1.6 in the Compiler complience level list-box.
    • Select the Use default complience setting check-box.
    • Click the Apply button.
  • Go to the Java -> Compiler -> Error/Warnings page.
    • Select Error in the Non-externalized strings (missing/unused $NON-NLS$ tag) list-box.
    • Click the Apply button.
  1. Set Editor preferences
  • Go to the Java -> Editor -> Save Actions page.
    • Make sure that all the following is selected:
      • Perform the selected actions on save
        • Format source code
          • Format all lines
        • Organize imports
        • Additional actions
          • Add missing '@Override' annotations
          • Add missing '@Override' annotations to implementations of interface methods
          • Add missing '@Deprecated' annotations
          • Remove unnecessary casts
    • Click the Apply button.
  • Go to the Java -> Editor -> Templates page.
    • Click the Import button.
    • Navigate to the dev-config\codeStyle subfolder of the team-explorer-everywhere repository.
    • Select the Java ALM Java Editor Templates.xml file and click Open.
    • Click the Apply button.
  1. Set Code Style preferences
  • Go to the Java -> Code Style -> Clean Up page.
    • Click the Import button.
    • Navigate to the dev-config\codeStyle subfolder of the team-explorer-everywhere repository.
    • Select the Java ALM Java Code Cleanup.xml file and click Open.
    • Make sure that Java ALM is selected in the Active profile list-box.
    • Click the Apply button.
  • Go to the Java -> Code Style -> Code Templates page.
    • Click the Import button.
    • Navigate to the dev-config\codeStyle subfolder of the team-explorer-everywhere repository.
    • Select the Java ALM Java Code Templates.xml file and click Open.
    • Click the Apply button.
  • Go to the Java -> Code Style -> Formatter page.
    • Click the Import button.
    • Navigate to the dev-config\codeStyle subfolder of the team-explorer-everywhere repository.
    • Select the Java ALM Java Code Formatting.xml file and click Open.
    • Make sure that Java ALM is selected in the Active profile list-box.
    • Click the Apply button.
  • Go to the Java -> Code Style -> Organize Import page.
    • Click the Import button.
    • Navigate to the dev-config\codeStyle subfolder of the team-explorer-everywhere repository.
    • Select the Java ALM Java Code.importorder file and click Open.
    • Click the Apply button.

Importing Projects

  1. Open Git Import Wizard using File -> Import -> Git ->Projects from Git.
  2. Select Existing local repository, click the Add button.
  3. Using the Browse button, navigate to and your local copy of the team-explorer-everywhere repository, select it, and click the Finish button.
  4. Click the Next button to switch to the Wizard Selection page.
  5. Select the Import existing Eclipse projects option and the source folder under the root of the repository.
  6. Click the Next button.
  7. Make sure that all com.microsoft.tfs.* project are selected and click the Finish button.

Dependencies

To install dependencies

  • Open the `com.mictosoft.tfs.client.eclipse.target' project.
  • Select the <version>.target file that matches to your Eclipse platform target version.
  • Open the file with the default editor (Target Editor). Whait until Eclipse downloads indexes of the referenced p2 repositories.
  • Click the Set as Target Platform link at the top right of the Target Definition view.
  • Open Window -> Preferences -> Plug-In Development->Target Platform` and make sure the desired target is selected.
  • Clean rebuild projects. (Project -> Clean -> Clean all projects)

Code Styles

A few styles we follow:

  1. No tabs in source code. All tabs should be expanded to 4 spaces.
  2. No imports with "*".
  3. The attribute final should be used whereever it's possible.
  4. All Java source files must have the following two lines at the top:
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See License.txt in the project root.
  1. We keep LF line-ending on the server. Please set the core.safecrlf git config property to true.
git config core.safecrlf true

Testing

  1. ...

Debugging

Creating Runtime Configurations

  1. Create a "Plugin" configuration to run/debug the plugin code.
  • Open the Debug Configurations window using Run -> Debug Configurations
  • Create a new Eclipse Application configuration:
    • Right click the Eclipse Application node in the configurations list.
    • Select the New pop menu option.
  • Enter a unique name for the new configuration
  • On the Main tab:
    • Select the Run a product option and org.eclipse.platform.ide.
    • Select the Execution environment option and the target Java version.
  1. Create a "CLC" configuration to run/debug the command-line client code.
  • Open the Debug Configurations window using Run -> Debug Configurations
  • Create a new Java Application configuration:
    • Right click the Java Application node in the configurations list.
    • Select the New pop menu option.
  • Enter a unique name for the new configuration
  • On the Main tab:
    • Set the Project to com.microsoft.tfs.client.clc.
    • Set the Main class to com.microsoft.tfs.client.clc.vc.Main.
  • On the Arguments tab:
    • In the VM arguments section add information for the TEE to locate its native libraries -Dcom.microsoft.tfs.jni.native.base-directory=${workspace_loc:com.microsoft.tfs.jni}/os
    • In the Program arguments section enter the tf command arguments for the run, e.g. workspaces /help.

Running Under the Debugger

  1. To debug the plugin or the command-line client, click Run -> Debug Configurations.
  2. Select the desired runtime configuration and click the Debug button.

Contribution License Agreement

In order to contribute, you will need to sign a Contributor License Agreement.

Submitting Pull Requests

We welcome pull requests! Fork this repo and send us your contributions. Go here to get familiar with GitHub pull requests.

Before submitting your request, ensure that all tests pass.