docs: add contibuter agreement, fix typo

canonical · Jul 19, 2022 · 37acae5 · 37acae5
1 parent af3de25
commit 37acae5
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 20 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -19,25 +19,6 @@ To build the charm locally, you will need to install [Charmcraft](https://juju.i
 
 To run the charm locally with Juju, it is recommended to use [LXD](https://linuxcontainers.org/lxd/introduction/) as your virtual machine manager. Instructions for running Juju on LXD can be found [here](https://juju.is/docs/olm/lxd).
 
-## 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 -e integration   # integration tests
-tox                  # runs 'lint' and 'unit' environments
-```
-
 ## Build and Deploy
 
 To build the charm in this repository, from the root of the dir you can run:
@@ -68,3 +49,26 @@ juju deploy ./*.charm -n 3
 # After ZooKeeper has initialised, relate the applications
 juju relate kafka zookeeper
 ```
+
+## 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 -e integration   # integration tests
+tox                  # runs 'lint' and 'unit' environments
+```
+
+## Canonical Contributor Agreement
+
+Canonical welcomes contributions to the Charmed Kafka Operator. Please check out our [contributor agreement](https://ubuntu.com/legal/contributors) if you're interested in contributing to the solution.
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ $ juju relate kafka zookeeper
 
 ## A fast and fault-tolerant, real-time event streaming platform!
 
-Manual, Day 2 operations for deploying and operating Apache Kafka, topic creation, client authentication, ACL management and more are al handled automatically using the [Juju Operator Lifecycle Manager](https://juju.is/docs/olm).
+Manual, Day 2 operations for deploying and operating Apache Kafka, topic creation, client authentication, ACL management and more are all handled automatically using the [Juju Operator Lifecycle Manager](https://juju.is/docs/olm).
 
 ### Key Features
 - SASL/SCRAM auth for Broker-Broker and Client-Broker authenticaion enabled by default.