CONTRIBUTING.md

Contributing to app-controller

Thanks for your help improving the app-controller!

Getting Help

If you have questions around app-controller, please contact the platform9 support or if you encounter any problem using it do raise an Issue, you can reach us via email at [email protected].

Workflow

Contribute to app-controller by following the guidelines below:

• Clone
• Make sure all app-controller prerequisites are met
• Auth0 prerequisites
• Setup local environment
• Work on the cloned repository
• Open a pull request to merge into app-controller repository

Building

Follow these steps to build from source and deploy:

1. Build app-controller binary
2. For DB Schema changes or first time builds.
3. Run app-controller either using binary or using system service file (preferred).
4. Logs for app-controller service can be found at /var/log/pf9/app-controller/app-controller.log

Running the unit tests and manual test

1. To run unit tests:

make test

2. When submitting the pull request, perform manual tests using app-controller APIs and attach snapshots or output files.

# List apps.
1. getApp API
# Deploy an app.
2. createApp API
# Describe an app.
3. getAppByName API
# Delete an app.
4. deleteApp API

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.