Skip to content

Latest commit

 

History

History
62 lines (49 loc) · 2.04 KB

CONTRIBUTING.md

File metadata and controls

62 lines (49 loc) · 2.04 KB
Raw

Contributing

Overview

This documents explains the processes and practices recommended for contributing enhancements to the Mongo Express charm.

  • Generally, before developing enhancements to this charm, you should consider opening an issue explaining your use case.
  • If you would like to chat with us about your use-cases or proposed implementation, you can reach us at Canonical Mattermost public channel or Discourse. The primary author of this charm is available on the Mattermost channel as @davigar15.
  • Familiarising yourself with the Charmed Operator Framework library will help you a lot when working on new features or bug fixes.
  • All enhancements require review before being merged. Code review typically examines
    • code quality
    • test coverage
    • user experience for Juju administrators this charm.
  • Please help us out in ensuring easy to review branches by rebasing your pull request branch onto the main branch. This also avoids merge commits and creates a linear Git commit history.

Developing

You can use the environments created by tox for development:

tox --notest -e unit
source .tox/unit/bin/activate

Testing

tox -e fmt           # update your code according to linting rules
tox -e lint          # code style
tox -e unit          # unit tests
# tox -e integration   # integration tests
tox                  # runs 'lint' and 'unit' environments

Build charm

Build the charm in this git repository using:

charmcraft pack

Deploy

# Create a model
juju add-model test-mongo-express
# Enable DEBUG logging
juju model-config logging-config="<root>=INFO;unit=DEBUG"
# Deploy the charm
juju deploy ./davigar15-mongo-express_ubuntu-20.04-amd64.charm \
  --resource mongo-express-image=mongo-express:0.54.0
# Get UI credentials
juju run-action davigar15-mongo-express/0 get-credentials --wait