CONTRIBUTING.md

Contributing to Cacher Run Server

Thanks for helping make Cacher better for coders!

@cacherapp/run-server is an NPM Node package written in Typescript (v2.7) and compiled into Javascript (es2017) for distributon.

Step 1: Run TSLint

Run tslint to check that your code conforms to the rules set by tslint.json:

npm run lint

Fix any errors and warnings.

Step 2: Manual Checks

Make sure the server builds and starts:

npm start https://app.cacher.io

Open a browser tab to https://app.cacher.io. Click to open the Run Server dialog:

Input your server's port and token and press Connect. Once the Run Server is connected, try to run a file example which might be affected by your changes. For example:

// HelloWorld.java
public class HelloWorld {
    public static void main(String[] args) { 
        System.out.println("Hello, World");
    }
}

Step 3: Submit the Pull Request

Please respect the Code of Conduct when creating your PR. Once it has been submitted, we will review your code within a few business days and make suggestions as necessary.