Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jnsgruk committed Oct 28, 2021
1 parent 712b6b2 commit 9f215b7
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Contributing to operator-libs-linux

## Bugs and pull requests

- Generally, before developing enhancements to this charm, you should consider 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](https://chat.charmhub.io/charmhub/channels/charm-dev)
or [Discourse](https://discourse.charmhub.io/).
- All enhancements require review before being merged. Apart from code quality and test coverage,
the review will also take into account the resulting user experience for Juju administrators
using this charm.

## Setup

A typical setup using [snaps](https://snapcraft.io/) can be found in the [Juju
docs](https://juju.is/docs/sdk/dev-setup).

## Developing

You can use the environments created by `tox` for development:

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

### Testing

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

## Build charm

Build the charm in this git repository using:

```shell
charmcraft pack
```

0 comments on commit 9f215b7

Please sign in to comment.