---
title: Charmhub | Deploy IRC Bridge using Charmhub - The Open Operator Collection
description: Deploy the latest version of IRC Bridge on any cloud.
url: https://charmhub.io/irc-bridge/docs/how-to-contribute
---

# IRC Bridge

[Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

* [Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps")

Platform:

22.04

edge b7e97982

```
juju deploy irc-bridge --channel edge
```

[Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications)

---

#### Contacts

##### Maintainers

+ [Launchpad Team](https://launchpad.net/~canonical-is-devops)

* [Submit a bug](https://github.com/canonical/irc-bridge-operator/issues)

---

Share your thoughts on this charm with the community on discourse.

[Join the discussion](https://discourse.charmhub.io/)

# How to contribute

This document explains the processes and practices recommended for contributing
enhancements to the IRC Bridge operator.

## [Overview](https://charmhub.io/irc-bridge/docs/how-to-contribute#p-38222-overview)

* Generally, before developing enhancements to this charm, you should consider
  [opening an issue](https://github.com/canonical/irc-bridge-operator/issues)
  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 Matrix public channel](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)
  or [Discourse](https://discourse.charmhub.io/t/about-the-getting-started-category/6007).
* Familiarizing yourself with the [Charmed Operator Framework](https://juju.is/docs/sdk)
  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 operators of 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](https://charmhub.io/irc-bridge/docs/how-to-contribute#p-38222-developing)

The code for this charm can be downloaded as follows:

```
git clone https://github.com/canonical/irc-bridge-operator
```

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

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

### [Testing](https://charmhub.io/irc-bridge/docs/how-to-contribute#p-38222-testing)

The following commands can be used to run the tests:

* `tox`: Runs all of the basic checks (`lint`, `unit`, `static`, and `coverage-report`).
* `tox -e fmt`: Runs formatting using `black` and `isort`.
* `tox -e lint`: Runs a range of static code analysis to check the code.
* `tox -e static`: Runs other checks such as `bandit` for security issues.
* `tox -e unit`: Runs the unit tests.
* `tox -e integration`: Runs the integration tests.

### [Changelog](https://charmhub.io/irc-bridge/docs/how-to-contribute#p-38222-changelog)

Please ensure that any new feature, fix, or significant change is documented by
adding an entry to the `docs/CHANGELOG.md` file.

To learn more about changelog best practices, visit [Keep a Changelog](https://keepachangelog.com/).

## [Build charm](https://charmhub.io/irc-bridge/docs/how-to-contribute#p-38222-build-charm)

Build the charm in this git repository using:

```
charmcraft pack
```

### [Deploy](https://charmhub.io/irc-bridge/docs/how-to-contribute#p-38222-deploy)

Refer to the [README.md](https://github.com/canonical/irc-bridge-operator/blob/main/README.md) file.

## [Canonical contributor agreement](https://charmhub.io/irc-bridge/docs/how-to-contribute#p-38222-canonical-contributor-agreement)

Canonical welcomes contributions to the Synapse Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you’re interested in contributing to the solution.

---