Chore/oss preparations (#23)

* added more info about the project

On-behalf-of: SAP [email protected]

* added badge and reuse

On-behalf-of: SAP [email protected]

* docs: extended description section and contributing instructions

On-behalf-of: SAP [email protected]

* chore: typo fix

On-behalf-of: SAP [email protected]

Author: OlegErshov

CODE_OF_CONFUCT.md

@@ -0,0 +1,86 @@
+# SAP Open Source Code of Conduct
+
+SAP adopts the [Contributor's Covenant 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)
+across our open source projects to ensure a welcoming and open culture for everyone involved.
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [[email protected]](mailto:[email protected]) (SAP Open Source Program Office). All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,111 @@
+## Overview
+
+# Contributing to platform-mesh
+We want to make contributing to this project as easy and transparent as possible.
+
+## Our development process
+We use GitHub to track issues and feature requests, as well as accept pull requests.
+
+## Pull requests
+You are welcome to contribute with your pull requests. These steps explain the contribution process:
+
+1. Fork the repository and create your branch from `main`.
+1. [Add tests](#testing) for your code.
+1. If you've changed APIs, update the documentation. 
+1. Make sure the tests pass. Our github actions pipeline is running the unit and e2e tests for your PR and will indicate any issues.
+1. Sign the Developer Certificate of Origin (DCO).
+
+## Testing
+
+> **NOTE:** You should always add if you are adding code to our repository.
+
+To let tests run locally, run `go test ./...` in the root directory of the repository.
+
+## Getting Started
+
+### Prerequisites
+- go version v1.24.0+
+- docker version 17.03+.
+- kubectl version v1.11.3+.
+- Access to a Kubernetes v1.11.3+ cluster.
+
+### To Deploy in the local cluster
+**Run the platform-mesh locally in the cluster:**
+
+To deploy the platform to kubernetes locally, please refer to the [helm-charts](https://github.com/platform-mesh/helm-charts) repository. 
+
+**Build and push your image to the local kind cluster where the platform-mesh system is deployed:**
+
+For that you can or spot which version is currently being used in the cluster and execute next commands:
+
+```bash
+docker build -t <image name which is used in the cluster with the tag> .
+
+kind load docker-image <image name which is used in the cluster with the tag> --name=platform-mesh
+```
+After it you need to restart security operator's pods and they will fetch a local image automaticly
+
+If you want to use another image name and tag use this approach
+
+```bash
+docker build -t security-operator:latest . && \
+kind load docker-image security-operator:latest --name=platform-mesh && \
+kubectl patch deployment platform-mesh-security-operator -n platform-mesh-system --type='json' -p='[{"op": "replace", "path": "/spec/template/spec/containers/0/imagePullPolicy", "value": "IfNotPresent"}]' && \
+kubectl patch deployment platform-mesh-security-operator -n platform-mesh-system --type='json' -p='[{"op": "replace", "path": "/spec/template/spec/containers/0/image", "value": "security-operator:latest"}]' && \
+kubectl rollout restart deployment platform-mesh-security-operator -n platform-mesh-system && \
+kubectl rollout status deployment platform-mesh-security-operator -n platform-mesh-system
+```
+
+**Install the CRDs into the cluster:**
+
+```bash
+task install
+```
+
+**Create instances of your solution**
+You can apply the samples (examples) from the config/sample:
+
+```bash
+kubectl apply -k config/samples/
+```
+
+>**NOTE**: Ensure that the samples has default values to test it out.
+
+### To Uninstall
+**Delete the instances (CRs) from the cluster:**
+
+```bash
+kubectl delete -k config/samples/
+```
+
+**Delete the APIs(CRDs) from the cluster:**
+
+```bash
+task uninstall
+```
+
+## Useful commands:
+### Run linter
+```bash
+task lint
+```
+### Coverage check
+```bash
+task cover
+```
+### Run tests
+```bash
+task test
+```
+### Check tests and linter
+```bash
+task validate
+```
+
+## Issues
+We use GitHub issues to track bugs. Please ensure your description is
+clear and includes sufficient instructions to reproduce the issue.
+
+## License
+By contributing to platform-mesh, you agree that your contributions will be licensed
+under its [Apache-2.0 license](LICENSE).