Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (43 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

58 lines (43 loc) · 1.77 KB
Raw

Contributing to appctl

Thanks for your help improving the appctl!

Getting Help

If you have questions around appctl, please contact the platform9 support or if you encounter any problem using it do raise an Issue, you can reach us via email at support@platform9.com.

Workflow

Contribute to appctl by following the guidelines below:

Building

Follow these steps to build from source and deploy:

  1. Hookup appctl with a local or a hosted app-controller
  2. Run the appropriate make target

  • Linux

    make build-linux64

  • Windows

    make build-win64

  • MacOS

    make build-mac
  1. To generate all the binaries run the default target. The executables are placed in bin directory.

Running the unit tests and manual test

  1. To run unit tests:
make test
  1. When submitting the Pull request, perform manual tests of all commands and attach snapshots or output files.
# Commands to test
1. appctl login
2. appctl deploy
3. appctl list
4. appctl describe 
5. appctl delete

Committing

Please follow the Pull request template, before raising a PR, so reviewers will gain a deeper understanding as they review. If an outstanding issue has been fixed, please include the Fixes Issue # in your commit message.