contributing.md

Setup

• Install Oracle JDK 8
  • JDK 9 or later will not work
• IntelliJ Toolbox
  • Use toolbox to install IntelliJ IDEA CE
  • PyCharm (also installed via toolbox) is useful for working with gcloud CLI
• GitHub Desktop

Working on the code

• Open test_runner/build.gradle.kts with IntelliJ IDEA Community
• There's an issue tracker and project board
• Run ./gradlew check to fix lint issues

See the main readme for instructions on how to run the iOS and Android samples.

Adding new gcloud property common to iOS and Android

• Add property to GcloudYml and update keys
• Update IArgs with new property
• Update AndroidArgs to reference the propery and update toString
• Update IosArgs to reference the propery and toString
• Add test to IosArgsTest
• Add test to IosRunCommandTest and update empty_params_parse_null test
• Add test to AndroidArgsTest
• Add test to AndroidRunCommandTest and update empty_params_parse_null test
• Update Android/iOS example config in README.md, flank.yml and flank.ios.yml

CLA

A CLA is required to contribute to flank. See walmart labs for more information. Google's open source policy explains why CLAs are commonly used