From d1be4b7816e42226ded2c32ed07fe625dcdd34d6 Mon Sep 17 00:00:00 2001 From: Guillermo Calvino Date: Thu, 29 Jun 2023 11:30:23 +0200 Subject: [PATCH] Enhacement of OSM bundle documentation Change-Id: I5b4ade65aa064fa76df678f4f9b00a7e0e9c711e Signed-off-by: Guillermo Calvino --- .../charm/bundles/osm/CODE_OF_CONDUCT.md | 96 +++++++++++++++++++ installers/charm/bundles/osm/CONTRIBUTING.md | 53 ++++++++++ installers/charm/bundles/osm/bundle.yaml | 3 +- installers/charm/osm-lcm/metadata.yaml | 2 +- 4 files changed, 152 insertions(+), 2 deletions(-) create mode 100644 installers/charm/bundles/osm/CODE_OF_CONDUCT.md create mode 100644 installers/charm/bundles/osm/CONTRIBUTING.md diff --git a/installers/charm/bundles/osm/CODE_OF_CONDUCT.md b/installers/charm/bundles/osm/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..121dcc88 --- /dev/null +++ b/installers/charm/bundles/osm/CODE_OF_CONDUCT.md @@ -0,0 +1,96 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, sex characteristics, gender identity and expression, +level of experience, education, socio-economic status, nationality, personal +appearance, race, religion, or sexual identity and orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team in the +[OSM public mattermost channel](https://chat.charmhub.io/charmhub/channels/charmed-osm). +All complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq \ No newline at end of file diff --git a/installers/charm/bundles/osm/CONTRIBUTING.md b/installers/charm/bundles/osm/CONTRIBUTING.md new file mode 100644 index 00000000..63c6178f --- /dev/null +++ b/installers/charm/bundles/osm/CONTRIBUTING.md @@ -0,0 +1,53 @@ + + +# Contributing + +## Overview + +This documents explains the processes and practices recommended for contributing enhancements to +this bundle. + +- Generally, before developing enhancements to this charm, you should consider [opening an issue + ](https://osm.etsi.org/bugzilla/enter_bug.cgi?product=OSM) explaining your use case. (Component=devops, version=master) +- If you would like to chat with us about your use-cases or proposed implementation, you can reach + us at [OSM Juju public channel](https://opensourcemano.slack.com/archives/C027KJGPECA). +- Familiarising 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 administrators this charm. +- Please help us out in ensuring easy to review branches by rebasing your gerrit patch onto + the `master` branch. + +## Code Repository + +To clone the repository for this bundle: + +```shell +git clone "https://osm.etsi.org/gerrit/osm/devops" +``` + +The bundle can be found in the following directory: + +```shell +cd devops/installers/charm/bundles/osm +``` diff --git a/installers/charm/bundles/osm/bundle.yaml b/installers/charm/bundles/osm/bundle.yaml index 402924d9..b2db446c 100644 --- a/installers/charm/bundles/osm/bundle.yaml +++ b/installers/charm/bundles/osm/bundle.yaml @@ -14,6 +14,7 @@ name: osm bundle: kubernetes docs: https://discourse.charmhub.io/t/osm-docs-index/8806 +issues: https://osm.etsi.org/bugzilla/ description: | **Single instance Charmed OSM** @@ -22,7 +23,7 @@ description: | to the development stack for OSM and allows you to deploy a single instance OSM bundle that is fast, reliable, and a complete solution with MicroStack and MicroK8s. - - Industry‐aligned and fully compliant with upstream + - Industry-aligned and fully compliant with upstream - Predictable release cadence and upgrade path - Simplified deployments and operations - Stable and secure diff --git a/installers/charm/osm-lcm/metadata.yaml b/installers/charm/osm-lcm/metadata.yaml index e38e2b57..b7dfa3d4 100644 --- a/installers/charm/osm-lcm/metadata.yaml +++ b/installers/charm/osm-lcm/metadata.yaml @@ -63,4 +63,4 @@ requires: interface: ro limit: 1 vca: - interface: osm-vca \ No newline at end of file + interface: osm-vca -- 2.25.1