installers/charm/bundles/osm/CONTRIBUTING.md

   1 <!-- Copyright 2022 ETSI
   2
   3 Licensed under the Apache License, Version 2.0 (the "License"); you may
   4 not use this file except in compliance with the License. You may obtain
   5 a copy of the License at
   6
   7         http://www.apache.org/licenses/LICENSE-2.0
   8
   9 Unless required by applicable law or agreed to in writing, software
  10 distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  11 WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  12 License for the specific language governing permissions and limitations
  13 under the License.
  14
  15 For those usages not covered by the Apache License, Version 2.0 please
  16 contact: legal@canonical.com
  17
  18 To get in touch with the maintainers, please contact:
  19 osm-charmers@lists.launchpad.net -->
  20
  21 # Contributing
  22
  23 ## Overview
  24
  25 This documents explains the processes and practices recommended for contributing enhancements to
  26 this bundle.
  27
  28 - Generally, before developing enhancements to this charm, you should consider [opening an issue
  29   ](https://osm.etsi.org/bugzilla/enter_bug.cgi?product=OSM) explaining your use case. (Component=devops, version=master)
  30 - If you would like to chat with us about your use-cases or proposed implementation, you can reach
  31   us at [OSM Juju public channel](https://opensourcemano.slack.com/archives/C027KJGPECA).
  32 - Familiarising yourself with the [Charmed Operator Framework](https://juju.is/docs/sdk) library
  33   will help you a lot when working on new features or bug fixes.
  34 - All enhancements require review before being merged. Code review typically examines
  35   - code quality
  36   - test coverage
  37   - user experience for Juju administrators this charm.
  38 - Please help us out in ensuring easy to review branches by rebasing your gerrit patch onto
  39   the `master` branch.
  40
  41 ## Code Repository
  42
  43 To clone the repository for this bundle:
  44
  45 ```shell
  46 git clone "https://osm.etsi.org/gerrit/osm/devops"
  47 ```
  48
  49 The bundle can be found in the following directory:
  50
  51 ```shell
  52 cd devops/installers/charm/bundles/osm
  53 ```