Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.29 KB

DEVELOPER_GUIDE.md

File metadata and controls

45 lines (28 loc) · 1.29 KB

Developer Guide

So you want to contribute code to this project? Excellent! We're glad you're here. Here's what you need to do.

Forking and Cloning

Fork this repository on GitHub, and clone locally with git clone.

Install Prerequisites

Node and npm

OpenSearch Perftop uses Node 10 at a minimum (version >= v10.0 < v11.0). This means you must have correct node version installed.

Building

To build from the command line, use ./gradlew.

./gradlew clean
./gradlew build -Dbuild.linux={true/false} -Dbuild.macos={true/false}

Build Issues

  1. eslint should not lint through the node_modules folder by default, if it does not obey that rule, try deleting the package-lock.json file and re-run npm install. This can be followed as a first step towards other build issues as well.

Using IntelliJ IDEA

Launch Intellij IDEA, choose Import Project, and select the build.gradle file in the root of this package.

Submitting Changes

See CONTRIBUTING.